Skip to main content

[![PyPI version](https://badge.fury.io/py/colonyscanalyser.svg)](https://pypi.org/project/colonyscanalyser/) [![Known Vulnerabilities](https://snyk.io//test/github/Erik-White/ColonyScanalyser/badge.svg?targetFile=requirements.txt)](https://snyk.io//test/github/Erik-White/ColonyScanalyser?targetFile=requirements.txt) [![GitHub](https://img.shields.io/github/license/erik-white/colonyscanalyser?color=blue)](https://github.com/Erik-White/ColonyScanalyser/blob/master/LICENSE)

# ColonyScanalyser

An image analysis tool for measuring microorganism colony growth.

ColonyScanalyser will analyse and collate statistical data from cell-culture plate images. It requires a series of images from a fixed point that show the development of microorganism colonies over time.

<img align=”right” src=”docs/images/growth_curve_small.png”>

ColonyScanalyser can provide information on: * Colony growth lag time (time of appearance) * Bimodal lag time distribution (comparing lag times of two colonies) * Colony area growth over time

By default, it will output a set of data and plots that summarize the information from all the plates in the image series. If you require further detail, such as plots of each individual plate, you can increase the save_plots command line argument.

## Getting Started

  • Install the [prerequisites](#prerequisites) and [package](#installing)

  • Locate your image series in a folder e.g. userimagesseries1

  • Run the analysis using ColonyScanalyser scanalyser userimagesseries1

There are various command line arguments that can alter the way the package is run. To see a list of arguments and information on each, run the command scanalyser –help

For example, to run the package ‘silently’ with no console output: scanalyser userimagesseries1 –verbose 0

### Prerequisites

Optionally use a virtual environment, such as [Pipenv](https://github.com/pypa/pipenv).

For testing: * [Pytest](https://pytest.org/) * [Pytest-cov](https://github.com/pytest-dev/pytest-cov/)

### Installing

#### Using pip Install Scikit-image (unless already installed) ` pip install scikit-image `

Install ColonyScanalyser ` pip install colonyscanalyser `

#### From github (requires [git](https://git-scm.com/) install) ` git clone https://github.com/erik-white/colonyscanalyser.git cd colonyscanalyser pip install -e . `

## Testing

Install the package with the extra test packages: pip install colonyscanalyser[test]

Run the tests: pytest –cov colonyscanalyser

## Contributing

Please read [CONTRIBUTING.md](docs/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/erik-white/scanalyser/tags).

## License

This project is licensed under the GPLv3 - see the [LICENSE](LICENSE) file for details

## Acknowledgments

Metadata

Release files for colonyscanalyser 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for colonyscanalyser 0.2.0
File Size Uploaded Provenance Actions
colonyscanalyser-0.2.0.tar.gz 23.4 kB Without provenance Details for colonyscanalyser-0.2.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for colonyscanalyser 0.2.0
File Interpreter ABI Platform Actions
colonyscanalyser-0.2.0-py3-none-any.whl Python 3 none any Details for colonyscanalyser-0.2.0-py3-none-any.whl

Total release size: 62.4 kB

Release files / colonyscanalyser-0.2.0.tar.gz

Download URL colonyscanalyser-0.2.0.tar.gz
Size 23.4 kB
Tags Source
SHA-256 checksum
How to use checksums
c382284247285a712a0de7292c8e0b1fb76d4675544c326994bd6b6448a773a3
BLAKE2b-256 checksum
How to use checksums
2b78a458b85447627b7ca34d79d9d846e7afd17f9df469cc1f46bfaddf40ad02
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.14.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.4

Release files / colonyscanalyser-0.2.0-py3-none-any.whl

Download URL colonyscanalyser-0.2.0-py3-none-any.whl
Size 39.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
27770c70934c52b3a5a569aeafe74c2f6819abffe309248739d758650bab9f6d
BLAKE2b-256 checksum
How to use checksums
aac69e1a1d2cc4941cd74f4359ab03df7f07cdfd2a74bd05bdba0074f431257e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.14.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.35.0 CPython/3.7.4

Security for colonyscanalyser 0.2.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page