Korpuskulum

A package for evaluating particle distribution with respect to segmented membranes.

Etymology: Corpuscle is an English word meaning a tiny particle, derived from the Latin "corpusculum".

Installation

You can install the package by running the following commands:

pip install -e .

Testing

You can run the package tests by running the following commands:

pip install .[test]
pytest

Basic usage

You can run the package by using a combination of flags after the following command

korpus main

The flags and their respective usages can be displayed using the command

korpus main --help

Issues

Please use the GitHub issue tracker to submit bugs or request features.

Contributions

If you would like to help contribute to python-template, please read our contribution guide and code of conduct.

License

Copyright Rosalind Franklin Institute, 2024.

Distributed under the terms of the Apache-2.0 license, python-template is free and open source software.