A package for quantifying cyclic molecule conformations.
Project description
==========
Tessellate
==========
.. image:: https://img.shields.io/pypi/v/tessellate.svg
:target: https://pypi.python.org/pypi/tessellate
.. image:: https://readthedocs.org/projects/tessellate/badge/?version=latest
:target: https://tessellate.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1068656.svg
:target: https://doi.org/10.5281/zenodo.1068656
A package for quantifying cyclic molecule conformations.
* Free software: Apache Software License 2.0
* Documentation: https://tessellate.readthedocs.io.
Using
-----
.. code:: bash
make install; tessellate data/example-builtin --input-format=builtin --output-format=json
make install; tessellate data/*DNA --input-format=pdblist --output-format=json
Installing
----------
- Use Python3. For example, Anaconda Python https://www.anaconda.com/download/ https://repo.continuum.io/archive/Anaconda3-5.0.1-Linux-x86_64.sh
- Use a virtual environment or conda environment.
- Install with pip or compile the source code
.. code:: bash
# installing with pip
pip install tessellate
# Alternatively: compile from source
make install
Usecase 1 - timeseries data
---------------------------
.. code:: bash
tessellate data/usecase-timeseries --input-format=builtin --output-format=json --output-dir=output-usecase-timeseries
This data is from an in vacuo ribose simulation stored in data/timeseries-from-VMD
To recreate data use the run.sh script. This calls VMD and runs pucker-bigdcd.tcl.
Usecase 2 - RNA and DNA
-----------------------
.. code:: bash
tessellate data/usecase-*DNA --input-format=pdblist --output-format=json --output-dir=output-usecase-rnadna
Usecase 3 - Alpha Cyclodextrin
------------------------------
.. code:: bash
tessellate data/usecase-*CD --input-format=pdblist --output-format=json --output-dir=output-usecase-cyclodextrin
Run All Usecases
----------------
.. code:: bash
tessellate data/usecase-timeseries --input-format=builtin --output-format=json --output-dir=output-usecase-timeseries
tessellate data/usecase-*DNA --input-format=pdblist --output-format=json --output-dir=output-usecase-rnadna
tessellate data/usecase-*CD --input-format=pdblist --output-format=json --output-dir=output-usecase-cyclodextrin
Viewing Data
------------
Try out Montage to create reports for these datasets.
For example:
.. code:: bash
USECASE_DATA=output-usecase-cyclodextrin
multiqc $USECASE_DATA -m comp_tessellate -f # -f to overwrite existing reports
google-chrome multiqc_report.html
Compare all outputs:
.. code:: bash
multiqc output* -m comp_tessellate -f # -f to overwrite existing reports
google-chrome multiqc_report.html
Development
-----------
Bump version numbers using bumpversion
X=thecurrentversion
`bumpversion --current-version X minor`
To bump from x.y.z to x.y.a use patch as the part:
`bumpversion --current-version X patch`
Features to include:
--------------------
* Improve testing and documentation. Port existing tests over.
* Tables
* include more RAD functionality
Uploading to PyPi
-----------------
Use twine
.. code:: bash
conda install -c conda-forge twine
make install
make dist
twine upload dist/*
Issues
------
Report Issues at https://github.com/scientificomputing/tessellate/issues
Known issue - only relative paths supported
Read the Docs
-------------
Docs are here. RTD is authorised to acces GitHub repos. The RTD service hook builds doc on push.
Credits
---------
This package incorporates work from existing packages (all originally developed by Chris B. Barnett.)
* https://bitbucket.org/scientificomputing/triangular-tessellation-class http://git.cem.uct.ac.za/analysis-pucker/triangular-tessellation-class
* https://bitbucket.org/scientificomputing/ring-analytics-webserver https://bitbucket.org/rxncor/rad-dev http://git.cem.uct.ac.za/analysis-pucker/ring-analytics-dash
* https://bitbucket.org/scientificomputing/triangular-tessellation-in-vmd http://git.cem.uct.ac.za/analysis-pucker/triangular-decomposition-timeseries-in-VMD
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
=======
History
=======
0.3.6 (2017-12-18)
------------------
* Zenodo DOI
* empty list bug resolved
* feature order json output
0.3.5 (2017-11-30)
------------------
* Includes tcl script for VMD and example data
0.3.4 (2017-11-29)
------------------
* Documentation update. Ring finder update
0.3.1 0.3.2 0.3.3 (2017-11-24)
------------------
* Usecase, documentation update. Update requirements for PyPi
0.3.0 (2017-11-23)
------------------
* First release on PyPi
0.2.0 (2017-11-23)
------------------
* Alpha version that can read PDBlists and builtin, can write json
* Include examples and much verbose logging
0.1.0 (2017-11-21)
------------------
* Alpha version. Basic function
Tessellate
==========
.. image:: https://img.shields.io/pypi/v/tessellate.svg
:target: https://pypi.python.org/pypi/tessellate
.. image:: https://readthedocs.org/projects/tessellate/badge/?version=latest
:target: https://tessellate.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1068656.svg
:target: https://doi.org/10.5281/zenodo.1068656
A package for quantifying cyclic molecule conformations.
* Free software: Apache Software License 2.0
* Documentation: https://tessellate.readthedocs.io.
Using
-----
.. code:: bash
make install; tessellate data/example-builtin --input-format=builtin --output-format=json
make install; tessellate data/*DNA --input-format=pdblist --output-format=json
Installing
----------
- Use Python3. For example, Anaconda Python https://www.anaconda.com/download/ https://repo.continuum.io/archive/Anaconda3-5.0.1-Linux-x86_64.sh
- Use a virtual environment or conda environment.
- Install with pip or compile the source code
.. code:: bash
# installing with pip
pip install tessellate
# Alternatively: compile from source
make install
Usecase 1 - timeseries data
---------------------------
.. code:: bash
tessellate data/usecase-timeseries --input-format=builtin --output-format=json --output-dir=output-usecase-timeseries
This data is from an in vacuo ribose simulation stored in data/timeseries-from-VMD
To recreate data use the run.sh script. This calls VMD and runs pucker-bigdcd.tcl.
Usecase 2 - RNA and DNA
-----------------------
.. code:: bash
tessellate data/usecase-*DNA --input-format=pdblist --output-format=json --output-dir=output-usecase-rnadna
Usecase 3 - Alpha Cyclodextrin
------------------------------
.. code:: bash
tessellate data/usecase-*CD --input-format=pdblist --output-format=json --output-dir=output-usecase-cyclodextrin
Run All Usecases
----------------
.. code:: bash
tessellate data/usecase-timeseries --input-format=builtin --output-format=json --output-dir=output-usecase-timeseries
tessellate data/usecase-*DNA --input-format=pdblist --output-format=json --output-dir=output-usecase-rnadna
tessellate data/usecase-*CD --input-format=pdblist --output-format=json --output-dir=output-usecase-cyclodextrin
Viewing Data
------------
Try out Montage to create reports for these datasets.
For example:
.. code:: bash
USECASE_DATA=output-usecase-cyclodextrin
multiqc $USECASE_DATA -m comp_tessellate -f # -f to overwrite existing reports
google-chrome multiqc_report.html
Compare all outputs:
.. code:: bash
multiqc output* -m comp_tessellate -f # -f to overwrite existing reports
google-chrome multiqc_report.html
Development
-----------
Bump version numbers using bumpversion
X=thecurrentversion
`bumpversion --current-version X minor`
To bump from x.y.z to x.y.a use patch as the part:
`bumpversion --current-version X patch`
Features to include:
--------------------
* Improve testing and documentation. Port existing tests over.
* Tables
* include more RAD functionality
Uploading to PyPi
-----------------
Use twine
.. code:: bash
conda install -c conda-forge twine
make install
make dist
twine upload dist/*
Issues
------
Report Issues at https://github.com/scientificomputing/tessellate/issues
Known issue - only relative paths supported
Read the Docs
-------------
Docs are here. RTD is authorised to acces GitHub repos. The RTD service hook builds doc on push.
Credits
---------
This package incorporates work from existing packages (all originally developed by Chris B. Barnett.)
* https://bitbucket.org/scientificomputing/triangular-tessellation-class http://git.cem.uct.ac.za/analysis-pucker/triangular-tessellation-class
* https://bitbucket.org/scientificomputing/ring-analytics-webserver https://bitbucket.org/rxncor/rad-dev http://git.cem.uct.ac.za/analysis-pucker/ring-analytics-dash
* https://bitbucket.org/scientificomputing/triangular-tessellation-in-vmd http://git.cem.uct.ac.za/analysis-pucker/triangular-decomposition-timeseries-in-VMD
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
=======
History
=======
0.3.6 (2017-12-18)
------------------
* Zenodo DOI
* empty list bug resolved
* feature order json output
0.3.5 (2017-11-30)
------------------
* Includes tcl script for VMD and example data
0.3.4 (2017-11-29)
------------------
* Documentation update. Ring finder update
0.3.1 0.3.2 0.3.3 (2017-11-24)
------------------
* Usecase, documentation update. Update requirements for PyPi
0.3.0 (2017-11-23)
------------------
* First release on PyPi
0.2.0 (2017-11-23)
------------------
* Alpha version that can read PDBlists and builtin, can write json
* Include examples and much verbose logging
0.1.0 (2017-11-21)
------------------
* Alpha version. Basic function
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
tessellate-0.3.6.tar.gz
(37.7 kB
view hashes)
Built Distribution
Close
Hashes for tessellate-0.3.6-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2eb33f7a8afb77390630cec94d7b8197e65c937efad5045c8ffa456aeb843af7 |
|
MD5 | ad6df01d3d3371485eed6a8fe1456def |
|
BLAKE2b-256 | 40d11f1532dbdcacb33773b7b8612f5f27378d8a92473f394101591c4eee2f3c |