|
| 1 | +.. _pytim: |
| 2 | + |
| 3 | +************************************************ |
| 4 | +pytim |
| 5 | +************************************************ |
| 6 | + |
| 7 | +| 🖋️ **Authors**: `pytim authors`_ |
| 8 | +| 🏠 **Project home:** https://github.com/Marcello-Sega/pytim |
| 9 | +| 📖 **Documentation:** https://marcello-sega.github.io/pytim |
| 10 | +| ⚖️ **License:** GPL-3.0-or-later |
| 11 | +| 🔑 **Keywords:** Surface analysis, Intrinsic properties |
| 12 | +| 📑 **Publications:** |
| 13 | +| * https://doi.org/10.1002/jcc.25384 |
| 14 | +| * https://onlinelibrary.wiley.com/doi/epdf/10.1002/jcc.25384 |
| 15 | +| 🧪 **Tests (latest):** |pytim_latest| |
| 16 | +| 🧪 **Tests (develop):** |pytim_develop| |
| 17 | +| **Description:** |
| 18 | +| *Provides several methods for the detection of fluid interfaces and analysis of their properties.* |
| 19 | +
|
| 20 | + |
| 21 | + |
| 22 | +Installation instructions |
| 23 | +========================= |
| 24 | + |
| 25 | +The latest version of pytim can be installed using the following: |
| 26 | + |
| 27 | +.. code-block:: bash |
| 28 | +
|
| 29 | + pip install pytim |
| 30 | +
|
| 31 | +The source code of pytim can be installed using the following: |
| 32 | + |
| 33 | +.. code-block:: bash |
| 34 | +
|
| 35 | + pip install git+https://github.com/Marcello-Sega/pytim@master |
| 36 | +
|
| 37 | +.. _`pytim authors`: |
| 38 | + https://github.com/Marcello-Sega/pytim/blob/master/AUTHORS.md |
| 39 | + |
| 40 | +.. |pytim_latest| image:: https://img.shields.io/badge/latest-passed-green.svg |
| 41 | + :alt: pytim develop CI status |
| 42 | + :target: https://github.com/MDAnalysis/MDAKits/actions |
| 43 | + |
| 44 | +.. |pytim_develop| image:: https://img.shields.io/badge/develop-passed-green.svg |
| 45 | + :alt: pytim develop CI status |
| 46 | + :target: https://github.com/MDAnalysis/MDAKits/actions |
| 47 | + |
0 commit comments