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.2.tar.gz (25.8 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.2-py3-none-any.whl (28.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kute-1.3.2.tar.gz
  • Upload date:
  • Size: 25.8 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.2.tar.gz
Algorithm Hash digest
SHA256 52d57454f68f16a4e7c97fb3c7f146c69671aa81319cc8804124929d6e855eed
MD5 8a4f4f704ed9141e6720f5c4568d5882
BLAKE2b-256 ccc5505e6df387a096c3e3cb250cfe8f6763e11fb8694d8ff3b2fae3ff6d13f7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kute-1.3.2-py3-none-any.whl
  • Upload date:
  • Size: 28.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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 8f2621a94079ca0376a104cbdad0fb174887605f0144c0a96639b497121f464d
MD5 fefedcb19b466ab8a2858a43c9f2d2b8
BLAKE2b-256 6e618fbd0e9f7717679f849a163d2d6fe24cfd13ac942eb92b64328bd88c927f

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