Skip to main content

PyPI version Known Vulnerabilities GitHub

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.

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 and package
  • Locate your image series in a folder e.g. \user\images\series1
  • Run the analysis using ColonyScanalyser scanalyser \user\images\series1

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 \user\images\series1 --verbose 0

Prerequisites

Optionally use a virtual environment, such as Pipenv.

For testing:

Installing

Using pip

Install Scikit-image (unless already installed)

pip install scikit-image

Install ColonyScanalyser

pip install colonyscanalyser

From github (requires git 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 for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the GPLv3 - see the LICENSE file for details

Acknowledgments

  • Levin-Reisman et al. for their work developing the ScanLag technique
  • Fabio Zanini for his original attempts at a Python implementation

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

  • Full unit test coverage
  • Type annotations on all functions

[0.3.1] - 2019-11-04

Fixed

  • Adjust setup to correctly find packages in implicit namespaces

[0.3.0] - 2019-11-04

Added

  • Added changelog

Changed

  • Update package to use src structure
  • Update setup for readme compatability with PyPi

[0.2.2] - 2019-11-02

Added

  • GitHub action for automatically linting and testing pushes
  • GitHub action for building and releasing package to PyPi

Fixed

  • Linting errors highlighted by flake8

[0.2.1] - 2019-10-31

Added

  • Graceful exit if no colonies are found
  • Workaround function to ensure correct plates are found in images

Changed

  • Improve Timepoint grouping by using distance comparison instead of rounding
  • Updated Scikit-image to v0.16

Removed

  • Depreciated Tk import
  • Removed depreciated regionprop coordinates

[0.2.0] - 2019-10-28

Added

  • Multiprocessing: greatly improves image processing speed
  • Now shows a progress bar when processing images
  • Snyk security checks for dependencies

Changed

  • Per image processing: now processes a single image at a time
  • Improve colony filtering, removes virtually all merged colonies
  • Updated readme with images and code examples

Fixed

  • Greatly reduced memory usage by using per-image processing
  • Filter out system files when locating images to process
  • Rare divide by zero error when processing colony object data

[0.1.2] - 2019-10-13

Inital release

Added

  • Image processing, plotting and data aggregation
  • Python package uploaded to PyPi

Metadata

Release files for colonyscanalyser 0.3.1

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.3.1
File Size Uploaded Provenance Actions
colonyscanalyser-0.3.1.tar.gz 21.4 kB Without provenance Details for colonyscanalyser-0.3.1.tar.gz

Built distribution (wheel)

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

Total release size: 55.1 kB

Release files / colonyscanalyser-0.3.1.tar.gz

Download URL colonyscanalyser-0.3.1.tar.gz
Size 21.4 kB
Tags Source
SHA-256 checksum
How to use checksums
20c4d320626f815d166b589fd40467bc9ecc3e97cf784241ac353711844bfeea
BLAKE2b-256 checksum
How to use checksums
c05522a3b5589e6a9f6263c2fa5abf56c30c523b311fc8e293fa107c2497ecf6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.37.0 CPython/3.8.0

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

Download URL colonyscanalyser-0.3.1-py3-none-any.whl
Size 33.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4de926d4c2593664e028cebe3420100218764e9b7155ad4a4153ffdfadb374bf
BLAKE2b-256 checksum
How to use checksums
64a67479290573696bc0212c9ebdd8a43dd79fcaad7986a24aa12c90433d2df8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/2.0.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.37.0 CPython/3.8.0

Security for colonyscanalyser 0.3.1

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