The CATNIP library

All the functions in the CATNIP library have been through a QA procedure, detailed in the QA instructions section below. All functions should be:

• Compatible with Python 2 and 3.
• Follow the PEP8 styling guidelines. We recommend Flake8 as one of the tools for enforcing PEP8 guidelines.
• Include a docstring that follows either numpy or google docstring style.
• Include a doctest.
• Have a github issue and code review associated with them.
• Have been reviewed by someone other than the original author.

Note: As of Jan 2020 module load scitools/default is currently the preferred software stack.

Useful commands and QA instructions

• Useful commands
  • Getting your own local copy of CATNIP
  • Doctest in brief
• QA instructions for the function writer
  • Open an issue
  • Create a branch
  • Add your function to the branch
  • Pushing your changes to the remote repository
  • Passing the function to the reviewer
  • Check out the branch to be reviewed
• QA instructions for the reviewer
  • Some Git best practices

CATNIP tools

• analysis module
• preparation module
• visualisation module
• utils module

Indices and tables

• Index
• Module Index
• Search Page