Recommendations for Usage

We recommend that cnmodel be used by importing it as a python module, rather than by attempting to develop code within the cnmodel directory. Thus, modeling projects should be in their own folder outside the cnmodel directory. The examples folder provides examples of how to use the cnmodel for some specific tasks, and these may be copied out into another directory where they can serve as a starting point for developing specific simulations.

If you update cnmodel from the main repository, it is a good idea to run the test.py script in the main folder to be sure that the basics are all working as they should. Any errors that appear in these runs should be addressed (fixed) before running simulations.