Setting upΒΆ

1. Fork and clone the Nighres github repository

You can find a good description here. Make sure that you set up your local clone to track both your fork (typically as origin) as well as the original Nighres repo (typically as upstream).

2. Make a new branch to work on

git checkout -b <branch_name>

This is important. When you make a pull request later, we will likely ask you to rebase because the Nighres master might have moved on since you forked it. You need a clean master branch for that.

Pick a descriptive branch name. For example, when you fix a bug in the function load_volume a good name is fix/load_volume. When you write a new interface called laminar_connectivity (that would be cool!) a good name is enh/laminar_connectivity.

Make one branch for each new feature or fix. That way independent changes can be handled in different pull requests later.

3. Install in editable mode (optional)

pip install -e <path_to_nighres_directory>

This way, when you import Nighres functions in Python, they will always come from the current version of the code in your Nighres directory. This is convenient for testing your code while developing.

(Alternatively, you can stay inside your Nighres directory and import functions directly from there without installing at all)

4. Let the coding begin!

If you want to work on an existing function, you can most likely just make your changes, check if the Examples still run and the move on to Adapting the docs and Making a Pull Request.

If you want to add new functions be sure to check out our intructions on Wrapping an existing CBS Tools class or Adding a new Python function


Please adhere to PEP8 style conventions. This is easiest by using a Python linter which is available in most editors.