|
| 1 | +.. _zarrtraj: |
| 2 | + |
| 3 | +************************************************ |
| 4 | +zarrtraj |
| 5 | +************************************************ |
| 6 | + |
| 7 | +| 🖋️ **Authors**: `zarrtraj authors`_ |
| 8 | +| 🏠 **Project home:** https://github.com/Becksteinlab/zarrtraj |
| 9 | +| 📖 **Documentation:** https://zarrtraj.readthedocs.io/en/latest/?badge=latest |
| 10 | +| ⚖️ **License:** GPL-3.0-or-later |
| 11 | +| 🔑 **Keywords:** streaming, trajectory, zarr, h5md, hdf5, AWS S3 Buckets, Google Cloud Buckets, Azure Blob Storage, Azure Data Lake |
| 12 | +| 🚀 **Development status:** Development Status :: 4 - Beta |
| 13 | +| 📜 **Changelog:** https://github.com/Becksteinlab/zarrtraj/blob/main/CHANGELOG.md |
| 14 | +| 📑 **Publications:** |
| 15 | +| * https://doi.org/10.25080/Majora-629e541a-00e |
| 16 | +| * https://doi.org/10.1002/jcc.21787 |
| 17 | +| * https://doi.org/10.1016/j.cpc.2014.01.018 |
| 18 | +| * https://doi.org/10.25080/majora-1b6fd038-005 |
| 19 | +| 🧪 **Tests (latest):** |zarrtraj_latest| |
| 20 | +| 🧪 **Tests (develop):** |zarrtraj_develop| |
| 21 | +| **Description:** |
| 22 | +| *Zarrtraj is a kit that provides the ability to stream & analyze H5MD trajectories from cloud storage.* |
| 23 | +
|
| 24 | + |
| 25 | + |
| 26 | +Installation instructions |
| 27 | +========================= |
| 28 | + |
| 29 | +The latest version of zarrtraj can be installed using the following: |
| 30 | + |
| 31 | +.. code-block:: bash |
| 32 | +
|
| 33 | + mamba install -c conda-forge zarrtraj |
| 34 | +
|
| 35 | +The source code of zarrtraj can be installed using the following: |
| 36 | + |
| 37 | +.. code-block:: bash |
| 38 | +
|
| 39 | + pip install git+https://github.com/Becksteinlab/zarrtraj@main |
| 40 | +
|
| 41 | +.. _`zarrtraj authors`: |
| 42 | + https://github.com/Becksteinlab/zarrtraj/blob/main/AUTHORS.md |
| 43 | + |
| 44 | +.. |zarrtraj_latest| image:: https://img.shields.io/badge/latest-passed-green.svg |
| 45 | + :alt: zarrtraj develop CI status |
| 46 | + :target: https://github.com/MDAnalysis/MDAKits/actions |
| 47 | + |
| 48 | +.. |zarrtraj_develop| image:: https://img.shields.io/badge/develop-passed-green.svg |
| 49 | + :alt: zarrtraj develop CI status |
| 50 | + :target: https://github.com/MDAnalysis/MDAKits/actions |
| 51 | + |
0 commit comments