search

WatsonGroupTCD / J2suscep

See https://github.com/WatsonGroupTCD/J2suscep/wiki
MIT License
3 stars 3 forks source link

Unit tests #2

Closed mturiansky closed 3 years ago

mturiansky commented 3 years ago

review for JOSS

Please include unit tests to ensure the proper operation of your code. In the present form, I see no way to actually validate that the results returned from the code are correct. (We always need to look out for those pesky factors of 2pi :smile:)

mfherbst commented 3 years ago

Again I agree with @mturiansky here. I would suggest using a simple example like the two-centre example suggested in #5 also for the purpose of unit testing as there the answer is probably easy to work out on pen and paper.

dpsanders commented 3 years ago

JOSS requires that there are tests, but they strictly do not need to be automated. However, I agree that setting up continuous integration is key for modern software projects.

Swetanshu commented 3 years ago

Automated tests have been implemented. These tests, use the examples provided in the package and verify that the compiled codes generate results similar to those provided with the examples. As some of the examples take significantly longer to run compared to others, the tests have been implemented in a way that one can selectively run shorter and longer tests (details described in the installation instructions).

mturiansky commented 3 years ago

The tests (short and long) work for me, so I'm closing this.