Development

Fork the current dev version: https://github.com/kr-colab/disperseNN2.git.

After cloning your fork, you can install with:

(.venv) $ git clone https://github.com/chriscrsmith/disperseNN2.git
(.venv) $ cd disperseNN2/
(.venv) $ pip install .

Once you’ve made your changes:

  1. run flake8, fix any issues.

  2. make sure the docs build, if they were edited.

  3. open a PR: https://github.com/kr-colab/disperseNN2