CONTRIBUTING.md

Style Guide

Compiling

SIPNET uses make to build the model and documentation. There are also miscellaneous targets for running analysis workflows:

# build SIPNET executable
make sipnet
# build documentation
make document
# clean up build artifacts
make clean
# list all make commands
make help

Testing

SIPNET also uses make to build and run its unit tests. This can be done with the following commands:

# Compile tests
make test
# Run tests
make testrun
# Clean after tests are run
make testclean

If changes are made to the modelStructure.h file and unit tests are failing, try running the update script as shown below. Consider running this script even if unit tests are not failing.

# Run this command from the root directory to update unit test versions of modelStructures.h
tests/update_model_structures.sh