Metadata-Version: 2.1
Name: pgfinder
Version: 0.0.3a1
Summary: Peptidoglycan analysis
License: GNU Lesser GPLv3
Project-URL: Source, https://github.com/Mesnage-Org/pgfinder
Project-URL: Bug_Tracker, https://github.com/Mesnage-Org/pgfinder/issues
Project-URL: Documentation, https://mesnage-org.github.io/pgfinder/
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Science/Research
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: COPYING
License-File: COPYING.LESSER
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: ruamel.yaml
Requires-Dist: pyyaml
Provides-Extra: dev
Requires-Dist: black ; extra == 'dev'
Requires-Dist: pre-commit ; extra == 'dev'
Requires-Dist: ruff ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: sphinx ; extra == 'docs'
Requires-Dist: myst-parser ; extra == 'docs'
Requires-Dist: numpydoc ; extra == 'docs'
Requires-Dist: pydata-sphinx-theme ; extra == 'docs'
Requires-Dist: sphinx-markdown-tables ; extra == 'docs'
Requires-Dist: sphinx-autoapi ; extra == 'docs'
Requires-Dist: sphinx-autodoc-typehints ; extra == 'docs'
Requires-Dist: sphinx-multiversion ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Requires-Dist: sphinxcontrib-mermaid ; extra == 'docs'
Requires-Dist: sphinxcontrib-napoleon ; extra == 'docs'
Provides-Extra: notebooks
Requires-Dist: jupyter ; extra == 'notebooks'
Requires-Dist: ipysheet ; extra == 'notebooks'
Provides-Extra: pypi
Requires-Dist: build ; extra == 'pypi'
Requires-Dist: setuptools-scm[toml] (>=6.2) ; extra == 'pypi'
Requires-Dist: versioneer (>=0.26) ; extra == 'pypi'
Requires-Dist: wheel ; extra == 'pypi'
Provides-Extra: tests
Requires-Dist: py ; extra == 'tests'
Requires-Dist: pytest (>=7.0) ; extra == 'tests'
Requires-Dist: pytest-cov ; extra == 'tests'
Requires-Dist: pytest-mpl ; extra == 'tests'
Requires-Dist: pytest-regtest ; extra == 'tests'
Requires-Dist: pytest-xdist ; extra == 'tests'

# PGFinder

![CI Tests](https://github.com/Mesnage-Org/pgfinder/actions/workflows/ci-tests.yml/badge.svg)
[![codecov](https://codecov.io/gh/Mesnage-Org/pgfinder/branch/master/graph/badge.svg?token=5SM94G9Z6K)](https://codecov.io/gh/Mesnage-Org/pgfinder)
[![PyPI version](https://img.shields.io/pypi/v/pgfinder?color=blue)](https://pypi.org/project/pgfinder/)
[![Docs](https://img.shields.io/badge/github.io-docs-green)](https://mesnage-org.github.io/pgfinder/)
[![](https://img.shields.io/badge/ORDA--DOI-10.15131%2Fshef.data.20101751.v1-lightgrey)](https://doi.org/10.15131/shef.data.20101751.v1)

Interactive notebooks are available for different versions from the links below. For descriptions of the features of each version
please refer to the [Releases](https://github.com/Mesnage-Org/pgfinder/releases) page. If you wish to use the latest changes
and improvements select the Notebooks from the `current` version which reflects changes made to the `master` branch that
have not yet been released.

| Version  | Interactive | Example |
|----------|-------------|---------|
| `current` | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/Mesnage-Org/PGFinder/master?urlpath=tree/pgfinder_interactive.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/Mesnage-Org/PGFinder/master?urlpath=tree/pgfinder.ipynb) |
| `v0.1.0` | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/Mesnage-Org/PGFinder/v0.1.0?urlpath=tree/pgfinder_interactive.ipynb) | [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/Mesnage-Org/PGFinder/v0.1.0?urlpath=tree/pgfinder.ipynb) |

  * [Introduction](https://mesnage-org.github.io/pgfinder/introduction.html)
  * [Installation](https://mesnage-org.github.io/pgfinder/installation.html)
  * [Usage](https://mesnage-org.github.io/pgfinder/usage.html)
  * [Contributing](https://mesnage-org.github.io/pgfinder/contributing.html)
  * [Copying](https://mesnage-org.github.io/pgfinder/copying.html)

## Links

  * [Mesnage Lab](https://mesnagelab.weebly.com/)

## References

  * [PGFinder, a novel analysis pipeline for the consistent, reproducible, and high-resolution structural analysis of bacterial peptidoglycans | eLife](https://elifesciences.org/articles/70597)
