Metadata-Version: 2.4
Name: py-packman
Version: 1.4.14
Summary: A software package for molecular PACKing and Motion ANalysis (PACKMAN)
Home-page: https://github.com/Pranavkhade/PACKMAN
Author: Pranav Khade
Author-email: pranavk@iastate.edu
License: MIT
Keywords: protein,dynamics,protein packing,protein domain,protein hinge
Classifier: Intended Audience :: Education
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: POSIX
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Classifier: Topic :: Scientific/Engineering :: Chemistry
Classifier: Topic :: Scientific/Engineering :: Mathematics
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: scipy
Requires-Dist: networkx
Requires-Dist: mlxtend
Requires-Dist: scikit-learn
Requires-Dist: tqdm
Requires-Dist: typing_extensions
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: requires-dist
Dynamic: summary

[![PyPI](https://badge.fury.io/py/py-packman.svg)](https://badge.fury.io/py/py-packman)
[![CI](https://github.com/Pranavkhade/PACKMAN/actions/workflows/python-package.yml/badge.svg)](https://github.com/Pranavkhade/PACKMAN/actions/workflows/python-package.yml)
[![Docs](https://readthedocs.org/projects/py-packman/badge/?version=latest)](https://py-packman.readthedocs.io/en/latest/)

<p align="center">
  <img src="docs/_static/gallary/logo.gif" alt="Classic animated PACKMAN logo" width="250">
</p>

# PACKMAN

PACKMAN (PACKing and Motion ANalysis) is a Python toolkit for protein
structure, packing, and motion analysis. It includes PDB/mmCIF structure tools,
hinge prediction, ANM/hdANM, GNM, packing entropy, and dynamic community
identification.

## Install

```console
python -m pip install py-packman
```

## Use PACKMAN

- **Python:** follow the [quickstart](https://py-packman.readthedocs.io/en/latest/quickstart.html).
- **Command line:** run `python -m packman --help`.
- **Desktop GUI:** run `python -m packman gui`.
- **Browser app:** see the [Streamlit guide](https://py-packman.readthedocs.io/en/latest/tutorials/streamlit.html)
  for hinge prediction, hdANM, packing entropy, and Docker instructions.

## Documentation and support

Browse the [documentation](https://py-packman.readthedocs.io/en/latest/),
[API map](https://py-packman.readthedocs.io/en/latest/api-map.html), or report
an issue in the [GitHub issue tracker](https://github.com/Pranavkhade/PACKMAN/issues).

## Web servers

- [Hinge prediction](https://packman.bb.iastate.edu/)
- [hdANM](https://hdanm.bb.iastate.edu/)
- [Packing entropy](https://packing-entropy.bb.iastate.edu/)
- [Dynamic community identification (DCI)](https://dci.bb.iastate.edu/)

## Related research articles

- [PACKMAN-molecule](https://doi.org/10.1093/bioadv/vbac007)
- [Hinge prediction](https://doi.org/10.1016/j.jmb.2019.11.018)
- [Structural compliance](https://doi.org/10.1002/prot.25968)
- [hdANM](https://doi.org/10.1016/j.bpj.2021.10.017)
- [Packing entropy](https://doi.org/10.1021/acsomega.2c00999)
- [DCI](https://doi.org/10.1093/bioinformatics/btac159)

## Acknowledgements

PACKMAN was developed from 2017 to 2022. NSF grant DBI-1661391 continues to
support the web servers. The authors thank
[ResearchIT@Iowa State University](https://researchit.las.iastate.edu/about-research-it-iowa-state-university)
for assistance with server deployment. Development since April 2022 has
proceeded without financial or other support.

See [LICENSE](LICENSE) for license terms.
