qiangyicheng / flory

Python package for finding coexisting phases in multicomponent mixtures.
https://flory.readthedocs.io/en/latest/
MIT License
4 stars 1 forks source link

Additional modules needed for tests #22

Open srmnitc opened 2 weeks ago

srmnitc commented 2 weeks ago

Part of review over at https://github.com/openjournals/joss-reviews/issues/7388

Point raised by @mastricker

For running the tests, I additionally needed to install pytest, pytest-cov, and matplotlib. Some test_examples are also skipped by default. Maybe these should be run?

qiangyicheng commented 3 days ago

Thank you for testing the package. We treat these packages as optional dependencies since they are not referenced by the main functionality of our package. Therefore, we chose not to include them directly and keep the dependencies of the package minimal. We provided an installation option dev to install these optional dependencies with pip, but did not make it clear in the documentation. Therefore, we have improved the documentation, and provided options example, test and doc to choose among groups of optional dependencies. Regarding the tests, we skipped some slow tests by default. These tests can be enabled with the --runslow option. We have also explained this in the revised README.md.