<p align="center">
<img src="https://github.com/hprats/ZacrosTools/blob/main/docs/images/logo_without_background.png?raw=true" alt="ZacrosTools Logo" width="200"/>
</p>
[](https://pypi.org/project/zacrostools/)
[](https://github.com/hprats/ZacrosTools/blob/main/LICENSE)
[](https://github.com/hprats/ZacrosTools/actions/workflows/ci.yml)
ZacrosTools is a versatile toolkit designed to simplify the preparation of **[Zacros](https://zacros.org/)** 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.
<div style="text-align: center;"> <img src="https://github.com/hprats/ZacrosTools/blob/main/examples/DRM_on_PtHfC/multiple_heatmaps.png?raw=true" alt="Multiple heatmaps" width="900"/> </div>
## Table of Contents
- [Features](#features)
- [Installation](#installation)
- [Prerequisites](#prerequisites)
- [Installing from Source](#installing-from-source)
- [Documentation](#documentation)
- [Changelog](#changelog)
- [Contributing](#contributing)
- [License](#license)
- [Contributors](#contributors)
## Key Features
- **Automatic input file generation**: Easily create Zacros input files, reducing errors.
- **Output file parsing**: Quickly read, analyze, and process Zacros output data.
- **Pressure and temperature scans**: Streamline the process of performing scans over different pressures and temperatures.
- **Documentation and examples:** Extensive documentation with detailed examples to help users get started and make full use of ZacrosTools.
## Installation
ZacrosTools is available on PyPI and can be installed using `pip`:
```bash
pip install zacrostools
```
### Prerequisites
- **Python 3.8 or higher**
- **[Scipy](https://scipy.org/)**
- **[Pandas](https://pandas.pydata.org/)**
These dependencies will be installed automatically with `pip`.
### Installing from Source
To install the latest development version from GitHub:
```bash
git clone https://github.com/hprats/ZacrosTools.git
cd ZacrosTools
pip install .
```
## Documentation
Comprehensive documentation is available at [zacrostools.readthedocs.io](https://zacrostools.readthedocs.io/en/latest/).
## Changelog
For a detailed list of changes, see [CHANGELOG.md](./CHANGELOG.md).
## Contributing
Contributions are welcome!
- **Report bugs**: Use the [issue tracker](https://github.com/hprats/ZacrosTools/issues) to report bugs.
- **Request features**: Suggest new features or improvements.
- **Submit pull requests**: Fork the repository and submit pull requests for your contributions.
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
## Contributors
- **Hector Prats** - [hector.prats@tuwien.ac.at](mailto:hector.prats@tuwien.ac.at)
Raw data
{
"_id": null,
"home_page": "https://github.com/hprats/ZacrosTools",
"name": "zacrostools",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "python, chemistry, KMC, ZACROS",
"author": "Hector Prats",
"author_email": "hpratsgarcia@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/3b/cd/e88580e09f17dc31eb8182e922192e1ae7287a07f3f97c96d8b29c92931d/zacrostools-2.2.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img src=\"https://github.com/hprats/ZacrosTools/blob/main/docs/images/logo_without_background.png?raw=true\" alt=\"ZacrosTools Logo\" width=\"200\"/>\n</p>\n\n[](https://pypi.org/project/zacrostools/)\n[](https://github.com/hprats/ZacrosTools/blob/main/LICENSE)\n[](https://github.com/hprats/ZacrosTools/actions/workflows/ci.yml)\n\nZacrosTools is a versatile toolkit designed to simplify the preparation of **[Zacros](https://zacros.org/)** 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.\n\n<div style=\"text-align: center;\"> <img src=\"https://github.com/hprats/ZacrosTools/blob/main/examples/DRM_on_PtHfC/multiple_heatmaps.png?raw=true\" alt=\"Multiple heatmaps\" width=\"900\"/> </div>\n\n## Table of Contents\n\n- [Features](#features)\n- [Installation](#installation)\n - [Prerequisites](#prerequisites)\n - [Installing from Source](#installing-from-source)\n- [Documentation](#documentation)\n- [Changelog](#changelog)\n- [Contributing](#contributing)\n- [License](#license)\n- [Contributors](#contributors)\n\n## Key Features\n\n- **Automatic input file generation**: Easily create Zacros input files, reducing errors.\n- **Output file parsing**: Quickly read, analyze, and process Zacros output data.\n- **Pressure and temperature scans**: Streamline the process of performing scans over different pressures and temperatures.\n- **Documentation and examples:** Extensive documentation with detailed examples to help users get started and make full use of ZacrosTools.\n\n## Installation\n\nZacrosTools is available on PyPI and can be installed using `pip`:\n\n```bash\npip install zacrostools\n```\n\n### Prerequisites\n\n- **Python 3.8 or higher**\n- **[Scipy](https://scipy.org/)**\n- **[Pandas](https://pandas.pydata.org/)**\n\nThese dependencies will be installed automatically with `pip`.\n\n### Installing from Source\n\nTo install the latest development version from GitHub:\n\n```bash\ngit clone https://github.com/hprats/ZacrosTools.git\ncd ZacrosTools\npip install .\n```\n\n## Documentation\n\nComprehensive documentation is available at [zacrostools.readthedocs.io](https://zacrostools.readthedocs.io/en/latest/).\n\n## Changelog\n\nFor a detailed list of changes, see [CHANGELOG.md](./CHANGELOG.md).\n\n## Contributing\n\nContributions are welcome!\n\n- **Report bugs**: Use the [issue tracker](https://github.com/hprats/ZacrosTools/issues) to report bugs.\n- **Request features**: Suggest new features or improvements.\n- **Submit pull requests**: Fork the repository and submit pull requests for your contributions.\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Contributors\n\n- **Hector Prats** - [hector.prats@tuwien.ac.at](mailto:hector.prats@tuwien.ac.at)\n",
"bugtrack_url": null,
"license": null,
"summary": "A collection of tools for the preparation of input files for ZACROS",
"version": "2.2",
"project_urls": {
"Download": "https://github.com/hprats/ZacrosTools/archive/refs/tags/v2.2.tar.gz",
"Homepage": "https://github.com/hprats/ZacrosTools"
},
"split_keywords": [
"python",
" chemistry",
" kmc",
" zacros"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3bcde88580e09f17dc31eb8182e922192e1ae7287a07f3f97c96d8b29c92931d",
"md5": "108685ab5f3feb375fdc1f5cafdc72f8",
"sha256": "fddfedc98b81589def7daed30553076de7f11506ef0ef2de25a66e254169ccf4"
},
"downloads": -1,
"filename": "zacrostools-2.2.tar.gz",
"has_sig": false,
"md5_digest": "108685ab5f3feb375fdc1f5cafdc72f8",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 60244,
"upload_time": "2024-12-20T11:00:37",
"upload_time_iso_8601": "2024-12-20T11:00:37.396605Z",
"url": "https://files.pythonhosted.org/packages/3b/cd/e88580e09f17dc31eb8182e922192e1ae7287a07f3f97c96d8b29c92931d/zacrostools-2.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-20 11:00:37",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hprats",
"github_project": "ZacrosTools",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [
{
"name": "numpy",
"specs": [
[
"~=",
"1.26.4"
]
]
},
{
"name": "pandas",
"specs": [
[
"~=",
"2.2.2"
]
]
},
{
"name": "matplotlib",
"specs": [
[
"~=",
"3.8.4"
]
]
},
{
"name": "setuptools",
"specs": [
[
"~=",
"70.3.0"
]
]
},
{
"name": "scipy",
"specs": [
[
"~=",
"1.13.1"
]
]
}
],
"lcname": "zacrostools"
}
JSON
