https://github.com/bio-phys/capriqorn
Capriqorn: CAlculation of P(R) and I(Q) Of macRomolecules in solutioN
https://github.com/bio-phys/capriqorn
dynamics molecular python saxs science simulations waxs
Last synced: 5 months ago
JSON representation
Capriqorn: CAlculation of P(R) and I(Q) Of macRomolecules in solutioN
- Host: GitHub
- URL: https://github.com/bio-phys/capriqorn
- Owner: bio-phys
- License: other
- Created: 2017-08-22T13:00:22.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2020-09-17T18:25:24.000Z (over 5 years ago)
- Last Synced: 2026-01-04T11:54:10.152Z (5 months ago)
- Topics: dynamics, molecular, python, saxs, science, simulations, waxs
- Language: Python
- Size: 11.8 MB
- Stars: 10
- Watchers: 4
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.rst
- License: LICENSE.txt
Awesome Lists containing this project
README
Capriqorn
=========
.. image:: doc/img/capriqorn_logo_480.png
:align: center
Introduction
------------
Capriqorn (CAlculation of P(R) and I(Q) Of macRomolecules in solutioN) is a molecular dynamics (MD)
data analysis package written in Python. It calculates the radial particle-pair
distribution function p(r) and the intensity I(q) from MD frames.
Capriqorn requires the Cadishi package to perform distance histogram
calculations.
Capriqorn was developed, built, and tested on SUSE Linux Enterprise Server 11 SP
4, Ubuntu Linux 14.04 LTS, and Scientific Linux 7 using cPython 2.7.11 from the
Anaconda Python distribution. It requires NumPy, SciPy, h5py, MDAnalysis and
Cadishi (https://github.com/bio-phys/cadishi) .
Documentation
-------------
Documentation is available at `http://capriqorn.readthedocs.io/en/latest/
`_.
Alternatively, you may access the local copy at `doc/html/index.html` after having
cloned the repository.
Installation
------------
The package is installed in the Pythonic way e.g. as follows::
$ python setup.py install --user # install into the user's home directory
Make sure to add `$HOME/.local/bin` to your PATH environment variable.
Quick start guide
-----------------
Capriqorn provides a single executable `capriq` that gives access to the
calculations. Run `capriq --help` to get an overview on the available commands
and options.
To run an example calculation based on the data set included in Capriqorn
proceed as follows::
1. Run `capriq example` to generate the necessary YAML input files for the
preprocessor, the histogram calculation, and the postprocessor.
Optionally, inspect and adapt the parameter files.
2. Run the preprocessor `capriq preproc`.
3. Run `capriq histo`
4. Run `capriq postproc`
Note that the step 2 is equivalent to the `cadishi` commands.
Licensing
---------
Capriqorn is released under the GPLv2 license. See the file
`LICENSE.txt` for details.
Copyright 2015 - 2017: Juergen Koefinger, Klaus Reuter, Max Linke
CITATION
--------
Please cite
| `Atomic-resolution structural information from scattering experiments on macromolecules in solution `_
| Jürgen Köfinger and Gerhard Hummer
| Phys. Rev. E 87, 052712 (2013)
For your convenience, we provide citations in the bibtex format and the endnote format in the folder `doc/citations`.