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.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c7e637043d914948c286e2375264c1d51cc90d7d56a258e2ace77a02b483ff3c |
|
MD5 | 53aa9a2bc499e9769a97e711e2133a9d |
|
BLAKE2b-256 | b5e94e3b6c38a6b4988a213a757bdbfda1fa54c056d866573289c99cb800fd4e |
Hashes for aind_segmentation_evaluation-0.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a032b92a861c4e7f17cb61ab860919a42a3db555d7d251408cf65b0e63969f66 |
|
MD5 | eea68dcc8e5c527e6c38a8c90c4db233 |
|
BLAKE2b-256 | 36c4f44f412c8ad36c60a3e580ed4158ae02c384d145930ee144a315d9f029bf |