Python package for evaluating neuron segmentations in terms of the number of splits and merges
Project description
aind-segmentation-evaluation
Python package for evaluating neuron segmentations in terms of the number of splits and merges.
Installation
To use the software, in the root directory, run
pip install -e .
To develop the code, run
pip install -e .[dev]
To install this package from PyPI, run
pip install aind-segmentation-evaluation
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 unittest discover && 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 .
- Use actionlint to check that the GitHub Actions workflows are valid:
actionlint
- Use commitlint to check that commit messages are valid:
commitlint --from=HEAD~1
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
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for aind_segmentation_evaluation-0.0.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | aae07717a0932c5a8671cce6b49a6aff4160908667d403d572c379b9b6e72c7e |
|
MD5 | b298b0bdd1eef7529aaf1d06317444ca |
|
BLAKE2b-256 | 4dc94f4e9fb00b21b1e699350c0917c75ac53c1516e5202d9df5c8cb08cad9b5 |
Hashes for aind_segmentation_evaluation-0.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 306fe31fc5e7baeb8e4e9634ee56a2eb1c7421fbed00c0656f1129e2b9ff484a |
|
MD5 | ef4c8e40dd571c72ed6d8e67554f3118 |
|
BLAKE2b-256 | 8342a5d04f60ec01d95246a785e6605cd5491b8e467f6f00d783f6eb6ca2d1d4 |