Change in repository structure
- RangeShifter has been split and distributed across three repositories: one containing the core code of the simulation (this repo), one for the batch interface, and one for the GUI. All three interfaces (batch, GUI, and RangeShiftR) keep a version controlled copy of the core code via a git subtree. More information about this structure can be found in
CONTRIBUTING.md, and about git subtree usage in theREADME.md.
New Features:
CONTRIBUTING.md: explicit contribution policy and guidance on how to develop code for RangeShifter. We include a git cheatsheet to help out contributors.- RScore has a main: RScore can now be run as a standalone program, in which case it will run unit tests. This helps checking that the simulation logic keeps running correctly independently of any of the interfaces. Unit tests are yet to be developped and will be added through future releases.
- GitHub Actions check - added a GitHub workflow to automatically build RScore on GitHub Actions, then run it as a standalone program (that is, run unit tests).
- Use CMake when compiled as a standalone program or as a module for the batch interface. This allows compiler instructions to be shipped along with the source code, which should make it possible for developers to compile and run without having to configure their C++ compiler. In particular, Visual Studio now automatically configures the project for the user using CMake. RangeShiftR still uses Make instead, via the R packages facilities.
Minor Changes
- Included a proper README.md for RScore, describing the role of RScore in the RangeShifter ecosystem and how to use it as a git subtree
- Fixed indentation and removed some commented out lines to improve readability.
- Moved some utility functions from main into a separate file "Utils", again to improve readability.