mdproptools contains MD analysis tools
Project description
MDPropTools: MD Property Tools
MDPropTools is a Python package for computing structural and dynamical properties from
LAMMPS trajectory and output files.
The supported properties are:
| Category | Property |
|---|---|
| Structural | Radial distribution function (RDF) |
| Coordination number | |
| Cluster analysis | |
| Hydration number | |
| Number density | |
| Dynamical | Mean square displacement (MSD) |
| Diffusion coefficient | |
| Ionic conductivity (using Green-Kubo relation) | |
| Viscosity (using Green-Kubo relation) | |
| Residence time |
The release history and changelog can be found in the changelog.
📦 Installation
MDPropTools can be installed using pip:
pip install mdproptools
Or by cloning the repository and running the setup script:
git clone https://github.com/molmd/mdproptools.git
cd mdproptools
pip install -r requirements.txt
pip install .
If you are planning to contribute to the development of MDPropTools and need access
to development tools and dependencies, you can install the package with the dev extra:
pip install ".[dev]"
[!IMPORTANT]
MDPropToolshas been tested using Python 3.10. It is recommended to use this version.
💻 Usage
For examples on how to use MDPropTools, please see the Jupyter notebooks in the examples directory.
👥 Contributing
All bug reports, suggestions, feedback, and pull requests occurs in the MDPropTools GitHub repository. Some contribution guidelines can be found in the contributing notes.
📖 Citation
If you use MDPropTools in your research, please consider citing the following paper:
- Atwi, R., Bliss, M., Makeev, M., & Rajput, N. N. (2022). MISPR: An automated infrastructure for high-throughput DFT and MD simulations. Scientific Reports, 12(1), 1-16.
📜 License Information
MDPropTools is a free, open-source software package (distributed under the MIT license).
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file mdproptools-0.0.6.tar.gz.
File metadata
- Download URL: mdproptools-0.0.6.tar.gz
- Upload date:
- Size: 170.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.7.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
2c4ee9c06c464df90efcbecc9fc748ec6d2931a27523cb736028c876119d8348
|
|
| MD5 |
62cae6166025017713088c9c2f3649ad
|
|
| BLAKE2b-256 |
a6e4c293fcc3ab2032e382ea062959001d27dad3854cc9d3d7d2d78e82262699
|
File details
Details for the file mdproptools-0.0.6-py3-none-any.whl.
File metadata
- Download URL: mdproptools-0.0.6-py3-none-any.whl
- Upload date:
- Size: 47.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.7.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
ecbdc250bae92ff17858aed1cdab569615ff971651ae2392c4cab1c3d01261b1
|
|
| MD5 |
cbc822667c6bc24ddc9eb9130cf38eaf
|
|
| BLAKE2b-256 |
28292de6ddb79f62c216c9e896f9a026ad0a74c2e546e52983a31ebc6cce842a
|