Skip to main content

Cepstral Data Analysis of current time series for Green-Kubo transport coefficients

Project description

SporTran (FKA thermocepstrum)

A code to estimate transport coefficients from the cepstral analysis of a multi-variate current stationary time series.

PyPI version Documentation Status

Documentation

https://sportran.readthedocs.io

References

Developed by Loris Ercole, Riccardo Bertossa, Sebastiano Bisacchi under the supervision of prof. Stefano Baroni

Acknowledgment The development of this software is part of the scientific program of the EU MaX Centre of Excellence for Supercomputing Applications (Grant No. 676598, 824143) and has been partly funded through it.


Usage

There is a GUI that you can try after installing the package. Click here for instructions.

The code can be used as a library, for example in a Jupyter notebook. In the examples folder you can find some examples.

Alternatively, you can run the code analysis.py from the command line without any installation procedure. It can execute most of the cepstral analysis routines, returning the results in a series of data files and PDF plots. See the examples/example_commandline_NaCl folder and the help (python analysis.py --help) for more information.

Requirements

  • numpy
  • scipy
  • matplotlib
  • tkinter
  • markdown2
  • pillow

Installation

You can simply pip-install SporTran downloading it from PyPI with pip install sportran.

Alternatively:

  1. Clone this repository: git clone https://github.com/sissaschool/sportran.git
  2. Install the package with pip (dependencies will be automatically downloaded). For example:
cd sportran
pip install .

You are all set! You can check that the installation is working by trying to run the command sportran-analysis.

The Graphical User Interface can be started with the command sportran-gui.

Issues

You are strongly encouraged to report any issue on the official GitHub issues page.

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

sportran-1.0.0rc2.tar.gz (16.0 MB view details)

Uploaded Source

Built Distribution

sportran-1.0.0rc2-py3-none-any.whl (133.9 kB view details)

Uploaded Python 3

File details

Details for the file sportran-1.0.0rc2.tar.gz.

File metadata

  • Download URL: sportran-1.0.0rc2.tar.gz
  • Upload date:
  • Size: 16.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.7.13

File hashes

Hashes for sportran-1.0.0rc2.tar.gz
Algorithm Hash digest
SHA256 a03afdb6df90a406100d3c39935bdee78f34b6648e34071d9909b60b7e6ff033
MD5 a4497bd4493f3eac96fa135207236ada
BLAKE2b-256 fcb7ba20685906cdeb7b82979de78a1ff869cce0a38f139bfc1d9cb1a701ede7

See more details on using hashes here.

File details

Details for the file sportran-1.0.0rc2-py3-none-any.whl.

File metadata

  • Download URL: sportran-1.0.0rc2-py3-none-any.whl
  • Upload date:
  • Size: 133.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.7.13

File hashes

Hashes for sportran-1.0.0rc2-py3-none-any.whl
Algorithm Hash digest
SHA256 e966c97bb7a72e631307cdeee8eb4c82249ef2a16ef443e416d7be27d46cfc2d
MD5 409a126f54be7e1207b829ef15e38ba1
BLAKE2b-256 bec5eca315016c12b80d8fe49e141208487739a4951947cc83c0ae0c07331a32

See more details on using hashes here.

Supported by

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