Skip to content

Commit

Permalink
Updated Key Features
Browse files Browse the repository at this point in the history
  • Loading branch information
hprats committed Nov 7, 2024
1 parent e03fddc commit c79ec6b
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 7 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ ZacrosTools is a versatile toolkit designed to simplify the preparation of **[Za
- [License](#license)
- [Contributors](#contributors)

## Features
## Key Features

- **Automatic input file generation**: Simplify the creation of Zacros input files, reducing the risk of errors and speeding up the setup process.
- **Output file parsing**: Easily read, analyze and process data from Zacros output files.
Expand Down
13 changes: 7 additions & 6 deletions docs/source/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,13 @@ Welcome to the ZacrosTools documentation! This guide provides comprehensive info

ZacrosTools is a versatile toolkit designed to simplify the preparation and analysis of Kinetic Monte Carlo (KMC) simulations with **[Zacros](https://zacros.org/)**.

### Key Features:
- **User-friendly:** Simplifies the creation, execution, and analysis of Zacros simulations with intuitive Python functions and classes.
- **Automated Input Generation:** Generates Zacros input files for pressure or temperature scans, reducing the risk of errors and speeding up the setup process.
- **Result Analysis Tools:** Provides powerful tools for analyzing Zacros simulation outputs, including multiple plotting functions.
- **Extensibility:** Easily integrates with other Python libraries and tools, enabling seamless incorporation into broader computational workflows.
- **Documentation and Examples:** Extensive documentation is available, including detailed examples to help users quickly get started and make the most of ZacrosTools.
## Key Features

- **Automatic input file generation**: Simplify the creation of Zacros input files, reducing the risk of errors and speeding up the setup process.
- **Output file parsing**: Easily read, analyze and process data from Zacros output files.
- **Pressure and temperature scans**: Streamline the process of performing scans over different pressures and temperatures.
- **Customizable workflows**: Create customised workflows to fit specific simulation needs.
- **Documentation and examples:** Extensive documentation is available, including detailed examples to help users quickly get started and make the most of ZacrosTools.

<div style="text-align: center;">
<img src="https://github.com/hprats/ZacrosTools/blob/main/docs/images/plot_multiple_runs/ScanTof.png?raw=true" alt="ScanTof" width="400"/>
Expand Down

0 comments on commit c79ec6b

Please sign in to comment.