search

mirapy-org / mirapy

MiraPy: A Python package for Deep Learning in Astronomy
https://mirapy.org/
MIT License
44 stars 10 forks source link

Adding tests #39

Closed DanielLenz closed 5 years ago

DanielLenz commented 5 years ago

Hi, I'm currently reviewing mirapy for publication in JOSS (https://github.com/openjournals/joss-reviews/issues/1557).

Could you add a suite of (unit)tests to the project that verify the software? It's one of the JOSS requirements.

Thank you!

swapsha96 commented 5 years ago

Currently, I have written tests for fitting module. Since other modules require large datasets for testing, I have not written any specific tests for them right now. You can run the tests by running the following command in the cloned repository:

python setup.py test

Since the requirement says:

Automated tests: Are there automated tests or manual steps described so that the function of the software can be verified?

I hope this requirement is satisfied.

DanielLenz commented 5 years ago

Thanks for pointing that out! I agree that it's difficult to test parts of the package that require large data, but part of the JOSS requirements is that most of the codebase is tested, not only a small part of it.

It would be awesome if you could add some very simple unit tests, and possibly provide the test coverage as well.

swapsha96 commented 5 years ago

Currently, the test coverage is 43%.

DanielLenz commented 5 years ago

Thanks for adding all these tests!