abc-merfish-analysis

Shared tools for accessing and processing ABC Atlas MERSCOPE data.

Usage

See usage examples in the accompanying notebook repository: https://github.com/AllenNeuralDynamics/thalamus-merfish-analysis

Installation

To use the software, install from github via

pip install git+https://github.com/AllenNeuralDynamics/abc-merfish-analysis

For the full functionality (unless just using to load data), install with the "plot" extras:

pip install git+https://github.com/AllenNeuralDynamics/abc-merfish-analysis[plot]

Contributing

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 Conventional Commits style for commit messages. Roughly, they should follow the pattern:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

where type is one of:

• fix: A bugfix
• feat: A new feature
• 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
• 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):

Commit message	Release type
fix(pencil): stop graphite breaking when too much pressure applied	Patch Fix Release, Default release
feat(pencil): add 'graphiteWidth' option	Minor Feature Release
perf(pencil): remove graphiteWidth option BREAKING CHANGE: The graphiteWidth option has been removed. The default graphite width of 10mm is always used for performance reasons.	Major Breaking Release (Note that the BREAKING CHANGE: token must be in the footer of the commit)