Welcome to aind-ophys-utils

Python utility library for processing calcium imaging (optical physiology) data. All interfaces are array-based (NumPy / h5py) with no project-specific data structures, making the modules easy to integrate into any pipeline.

Modules

Installation

pip install aind-ophys-utils

GPU / CPU note. aind-ophys-utils depends on PyTorch, which pulls in CUDA libraries by default from PyPI (~2 GB). To install a CPU-only build instead, install PyTorch first using the official CPU index, then install this package:

pip install torch --index-url https://download.pytorch.org/whl/cpu
pip install aind-ophys-utils

Alternatively, pass --extra-index-url in a single command:

pip install aind-ophys-utils --extra-index-url https://download.pytorch.org/whl/cpu

To use the software from source, clone the repository and in the root directory run

pip install -e .

To develop the code in place, run

pip install -e .[dev]

Contributing

Linters and testing

There are several libraries used to run linters, check documentation, and run tests.

• Please test your changes using the coverage library, which will run the tests and log a coverage report:

coverage run -m pytest && coverage report

• Use interrogate to check that modules, methods, etc. have been documented thoroughly:

interrogate .

• Use flake8 to check that code is up to standards (no unused imports, etc.):

flake8 .

• Use black to automatically format the code into PEP standards:

black .

• Use isort to automatically sort import statements:

isort .

Pull requests

For internal members, please create a branch. For external members, please fork the repository and open a pull request from the fork. We'll primarily use Angular style for commit messages. Roughly, they should follow the pattern:

<type>(<scope>): <short summary>

where scope (optional) describes the packages affected by the code changes and type (mandatory) is one of:

• build: Changes that affect build tools or external dependencies (example scopes: pyproject.toml, setup.py)
• ci: Changes to our CI configuration files and scripts (examples: .github/workflows/ci.yml)
• docs: Documentation only changes
• feat: A new feature
• fix: A bugfix
• perf: A code change that improves performance
• refactor: A code change that neither fixes a bug nor adds a feature
• test: Adding missing tests or correcting existing tests

Semantic Release

The table below, from semantic release, shows which commit message gets you which release type when semantic-release runs (using the default configuration):

Documentation

To generate the rst files source files for documentation, run

sphinx-apidoc -o doc_template/source/ src 

Then to create the documentation HTML files, run

sphinx-build -b html doc_template/source/ doc_template/build/html

More info on sphinx installation can be found here.