Skip to main content

green Kubo Uncertainty-based Transport Estimator

Project description

logo{width=50%}

KUTE: green-Kubo Uncertainty-based Transport properties Estimator

pipeline status coverage report Latest Release

Kute is a python module designed for the calculation of Green-Kubo integrals from molecular dynamics simulations. It includes features to calculate said integrals when the microscopic currents are known, as well as tools to compute these. Its workflow is summarized in the figure below kute_flowchart

Installation

To install KUTE, just clone this repository and run the following command

python -m pip install -e .

or use pip

pip install kute

with that, KUTE will be available both as a python module and as commandline functions that can be invoked.

Installing the LAMMPS plugin

Installation of the LAMMPS plugin requires the (re)compilation of LAMMPS. The contents of the lammps folder of this repository should be copied into the src folder of LAMMPS before the compilation. After that the current compute should be available (for more information check the documentation).

Documentation and quick start guide

The documentation, as well a a quick tutorial can be seen here

Cite us

If you found this useful, please consider citing our paper:

- https://doi.org/10.1021/acs.jcim.4c02219

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

kute-1.3.4.tar.gz (26.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kute-1.3.4-py3-none-any.whl (29.1 kB view details)

Uploaded Python 3

File details

Details for the file kute-1.3.4.tar.gz.

File metadata

  • Download URL: kute-1.3.4.tar.gz
  • Upload date:
  • Size: 26.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for kute-1.3.4.tar.gz
Algorithm Hash digest
SHA256 f9f5a98aa77c57545ff156a749ca96a8938b78bd2376fc39384e822d7b1a1e0b
MD5 fedd455371b720b9f54fcfe29f9f985f
BLAKE2b-256 3f7943ec07483c9832f6f3badf8a482657ce54404e0662883e15074c2fa8f0a0

See more details on using hashes here.

File details

Details for the file kute-1.3.4-py3-none-any.whl.

File metadata

  • Download URL: kute-1.3.4-py3-none-any.whl
  • Upload date:
  • Size: 29.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.3

File hashes

Hashes for kute-1.3.4-py3-none-any.whl
Algorithm Hash digest
SHA256 44790bf2de5604d387d9882669ebd7b2042534238a1c4a23fe0d28fa5c2381e6
MD5 bbac374e9e125c1dc1f12068c00e1a68
BLAKE2b-256 06f44a5f7796bfd1bb33d1dc2c2aebb0f63ad2cd54354b37df58f0555c97abf8

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page