[JOSS review] Add and/or properly document tests

ORNL / Equilipy

Open-source python package for multicomponent multiphase equilibrium CALPHAD calculations

https://ornl.github.io/Equilipy/

BSD 3-Clause "New" or "Revised" License

9 stars 2 forks source link

[JOSS review] Add and/or properly document tests #4

Closed mefuller closed 1 month ago

mefuller commented 2 months ago

Documentation does not identify any test suite. Please add to documentation if it already exists. If not, package should have tests, preferably integrated into CI.

SunyongKwon commented 1 month ago

Hi @mefuller, thank you so much for the feedback. I completely agree with your comment.

We integrated the test suite in ./test/ directory into our CI using the GitHub Actions. This test suite will ensure some core functions (equilib_single',equilib_batch, andscheil_cooling`) runs without raising errors. More rigorous tests will be added in the future along with the current test cases.

I added a brief description regarding the test suite in the Install section in our documentation.