Metadata-Version: 2.1
Name: pyCapsid
Version: 0.0.7
Summary: A set of computational tools written in python for the analysis of viral capsids
Home-page: https://github.com/luquelab/pycapsid
Author: Luque Lab, Colin Brown, Anuradha Agarwal
Author-email: colintravisbrown@gmail.com
License: MIT License
Classifier: Development Status :: 1 - Planning
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Python: <3.11
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# pyCapsid

## Description
A python package for identification of dominant motions and rigid domains of protein shells using Elastic Network Models.

## Installation
The package requires python < 3.11, we reccomend python 3.10.
Via pip:
~~~~
pip install pyCapsid
~~~~

Via conda: 
~~~~
conda install -c colintravisbrown -c conda-forge pycapsid
~~~~

## Documentation
Documentation is provided on our github pages site: [https://luquelab.github.io/pyCapsid/](https://luquelab.github.io/pyCapsid/)

## Examples
An example notebook is provided in the [notebooks folder](https://github.com/luquelab/pyCapsid/tree/main/notebooks).
An accompanying tutorial is provided in the documentation.

## Project History
This is an evolving repository
Started: 2022-10-24


## FILES & FOLDERS
FOLDER: /bin
--> This folder contains basic scripts and executable files.

FOLDER: /data
--> This folder contains the raw data associated with the project and the potential references.

FOLDER: /docs
--> This folder contains the manuscript, digital copies of the cited references, figures, and other associated files for publication.

FOLDER: /results
--> This folder contains the results, performance analysis, and commented references associated with the project.

FOLDER: /src
--> This folder contains source code of the package.

The syntax of markdown files (.md) is CommonMark unless specified otherwise (https://commonmark.org/help/)



