Skip to content

Versatile toolkit designed to simplify the preparation and analysis of Kinetic Monte Carlo (KMC) simulations with Zacros.

License

Notifications You must be signed in to change notification settings

hprats/ZacrosTools

Repository files navigation

ZacrosTools Logo

PyPI License CI codecov

ZacrosTools is a versatile toolkit designed to simplify the preparation of Zacros input files and the reading of Zacros output files. It is especially useful for performing pressure and temperature scans, which often require the generation of numerous input files and the processing of extensive output data.

Multiple heatmaps

Key Features

  • Automatize the creation of Zacros input files
  • Perform scans over different pressures and temperatures
  • Quickly read, analyze, and process Zacros output files
  • Easily plot heatmaps from the simulation results
  • Extensive documentation with detailed examples to help users get started

Installation

ZacrosTools is available on PyPI and can be installed using pip:

pip install zacrostools

Prerequisites:

Alternatively, the latest development version can be installed from GitHub as follows:

git clone https://github.com/hprats/ZacrosTools.git
cd ZacrosTools
pip install .

Documentation

Comprehensive documentation is available at zacrostools.readthedocs.io.

Changelog

For a detailed list of changes, see CHANGELOG.md.

What's next

We plan to continue improving ZacrosTools with additional features, optimizations, and support for more advanced Zacros functionalities. Contributions are welcome!

License

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

Contributors

Acknowledgements

  • Zeyu Wu

About

Versatile toolkit designed to simplify the preparation and analysis of Kinetic Monte Carlo (KMC) simulations with Zacros.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages