VlachosGroup / pMuTT

Python Multiscale Thermochemistry Toolbox (pMuTT)
https://vlachosgroup.github.io/pMuTT/
39 stars 21 forks source link
dft-to-thermdat nasa thermdat thermochemistry

Python Multiscale Thermochemistry Toolbox (pMuTT)

The P\ ython Mu\ ltiscale T\ hermochemistry T\ oolbox (pMuTT) is a Python library for Thermochemistry developed by the Vlachos Research Group at the University of Delaware. This code was originally developed to convert ab-initio data from DFT to observable thermodynamic properties such as heat capacity, enthalpy, entropy, and Gibbs energy. These properties can be fit to empirical equations and written to different formats.

.. image:: https://raw.githubusercontent.com/VlachosGroup/pMuTT/master/docs/source/logos/pmutt_web.png :target: https://vlachosgroup.github.io/pMuTT/ :align: center

Documentation

See our documentation page_ for examples, equations used, and docstrings.

Developers

Dependencies

Getting Started

  1. Install using pip (see documentation for more thorough instructions_)::

    pip install pmutt

  2. Look at examples using the code_

  3. Run the unit tests_.

License

This project is licensed under the MIT License - see the LICENSE.md_ file for details.

Publications

Contributing

If you have a suggestion or find a bug, please post to our Issues page_ with the |enhancement_label| or |bug_label| tag respectively.

Finally, if you would like to add to the body of code, please:

Questions

If you are having issues, please post to our Issues page_ with the |help_wanted_label| or |question_label| tag. We will do our best to assist.

Funding

This material is based upon work supported by the Department of Energy's Office of Energy Efficient and Renewable Energy's Advanced Manufacturing Office under Award Number DE-EE0007888-9.5.

Special Thanks

.. |bug_label| image:: https://raw.githubusercontent.com/VlachosGroup/pMuTT/master/docs/source/images/labels/bug_small.png :height: 20 :target: https://github.com/VlachosGroup/pMuTT/issues?utf8=%E2%9C%93&q=label%3Abug

.. |enhancement_label| image:: https://raw.githubusercontent.com/VlachosGroup/pMuTT/master/docs/source/images/labels/enhancement_small.png :height: 20 :target: https://github.com/VlachosGroup/pMuTT/issues?utf8=%E2%9C%93&q=label%3Aenhancement

.. |help_wanted_label| image:: https://raw.githubusercontent.com/VlachosGroup/pMuTT/master/docs/source/images/labels/help_wanted_small.png :height: 20 :target: https://github.com/VlachosGroup/pMuTT/issues?utf8=%E2%9C%93&q=label%3A%22help%20wanted%22

.. |question_label| image:: https://raw.githubusercontent.com/VlachosGroup/pMuTT/master/docs/source/images/labels/question_small.png :height: 20 :target: https://github.com/VlachosGroup/pMuTT/issues?utf8=%E2%9C%93&q=label%3Aquestion

.. _documentation page: https://vlachosgroup.github.io/pMuTT/ .. _Atomic Simulation Environment: https://wiki.fysik.dtu.dk/ase/ .. _Numpy: http://www.numpy.org/ .. _Pandas: https://pandas.pydata.org/ .. _xlrd: https://xlrd.readthedocs.io/en/latest/ .. _SciPy: https://www.scipy.org/ .. _Matplotlib: https://matplotlib.org/ .. _pyGal: http://www.pygal.org/en/stable/ .. _PyMongo: http://api.mongodb.com/python/current/ .. _dnspython: http://www.dnspython.org/ .. networkx: https://networkx.github.io/ .. More Itertools: https://more-itertools.readthedocs.io/en/stable/index.html .. _PyYAML: https://pyyaml.org/ .. _tests directory: https://github.com/VlachosGroup/pMuTT/tree/master/pmutt/tests .. LICENSE.md: https://github.com/VlachosGroup/pMuTT/blob/master/LICENSE.md .. see documentation for more thorough instructions: https://vlachosgroup.github.io/pMuTT/install.html .. _examples using the code: https://vlachosgroup.github.io/pMuTT/examples_jupyter/examples.html .. Issues page: https://github.com/VlachosGroup/pMuTT/issues .. pull request: https://github.com/VlachosGroup/pMuTT/pulls .. _unit tests: https://vlachosgroup.github.io/pMuTT/install.html#running-unit-tests