NASim is a work in progress and contributions are welcome via pull request.

For more information, you can check out this link : Contributing to an open source Project on github.


Here are a few guidelines for this project.

  • Simplicity: Be easy to use but also easy to understand when one digs into the code. Any additional code should be justified by the usefulness of the feature.

These guidelines come of course in addition to all good practices for open source development.

Code style

This project follows the PEP 8 style guide, please follow this with your contributions.

Additionally: * If a variable is intended to be ‘private’, it is prefixed by an underscore.


All contributions should be accompanied with at least in code docstrings, when applicable. This project uses Sphinx for documentation generation and uses Numpy style docstrings.

Please see code in this project for example or check out this example.