Contributing:

The aim of this repository is to maintain high-quality, well-written, and well-tested code for neural data analysis. To this end, all code must follow the guidelines laid out in the follwoing sections of this document.

For specific instructions on how to use github, see the Github SOP

If you are planning to make changes, clone the repo from github, then install, then use the -e flag to install in editable mode rather than installing a fixed version.

> git clone https://github.com/aolabNeuro/analyze.git
> cd analyze
> pip install -e .

If you previously installed aolab-aopy from pip, you can uninstall it with:

> pip uninstall aolab-aopy

• Writing code
  • Modules
  • Style
  • Function Checklist
    • Generic Datatypes
    • Consistent Variables
    • Argument order
    • General Comments
    • Imports
  • Adding new packages
• Writing documentation
  • Docstrings
    • Template
    • Example
    • Tips for vscode
      • Adding images
      • Adding equations
  • Documentation pages
• Writing tests
  • Why test?
  • What to test
  • How to write tests
    • Writing tests as you go
    • Code first, test later
  • Testing datasets
• Using github
  • Documentation
  • Pull requests