Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Shyamdeokr authored Jan 22, 2025
1 parent f55c97c commit 64a8b4e
Showing 1 changed file with 14 additions and 14 deletions.
28 changes: 14 additions & 14 deletions systems2atoms/materials/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Description

This repository contains scripts to compute **Turnover Frequency (TOF)** data (mol H/mol catalyst·hr) for palladium nanoparticles of specified sizes over a range of temperatures and pressures. The main script, `tof_map_dia.py`, calculates TOF values and generates 2D heatmaps for visualization.
This repository contains scripts to compute **Turnover Frequency (TOF)** data (mol H<sub>2</sub>/mol catalyst·hr) for palladium nanoparticles of specified sizes over a range of temperatures and pressures. The main script, `tof_map_dia.py`, calculates TOF values and generates 2D heatmaps for visualization.

The workflow uses **CATMAP** for microkinetics modeling (MKM), Wulff construction for nanoparticle geometry, and additional Python scripts for data processing. For detailed information about CATMAP, refer to its [documentation](https://catmap.readthedocs.io/en/latest/index.html).

Expand Down Expand Up @@ -32,7 +32,7 @@ The workflow uses **CATMAP** for microkinetics modeling (MKM), Wulff constructio

### 2. Wulff Construction Files
- **Input Scripts**:
- `fn_dia_site.py`: Constructs Wulff particles based on surface energies.
- `fn_dia_site.py`: Constructs Wulff particles based on surface energies ([https://crystalium.materialsvirtuallab.org/](https://crystalium.materialsvirtuallab.org/)).
- `NN_list_fn.py`: Calculates the surface fraction for different facets.

- **Output**:
Expand Down Expand Up @@ -81,9 +81,10 @@ resolution = 20

## Output

All results are saved in the output directory, including:
-`TOF Data: .csv, .xlsx, .npz files.`
-`TOF Heatmaps: .png images.`
All results are saved in the **output** directory, including:
- `TOF Data: .csv, .xlsx, .npz files.`

- `TOF Heatmaps: .jpg images.`

## Requirements

Expand All @@ -95,17 +96,16 @@ conda install -c conda-forge ase
```
2. CATMAP (documentation).
3. Python Libraries:
-`scipy`
-`matplotlib`
-`pandas`
-`openpyxl`
4. ASAP3 (documentation):
- `scipy`
- `matplotlib`
- `pandas`
- `openpyxl`
4. [ASAP3](https://asap3.readthedocs.io/en/latest/):
Used for neighbor list generation in Wulff construction.
## References
CATMAP Documentation
Kinetic Data Source (DOI: 10.1021/cs400664z)
- [CATMAP](https://catmap.readthedocs.io/en/latest/index.html)
- Kinetic Data Source: [DOI: 10.1021/cs400664z](https://pubs.acs.org/doi/10.1021/cs400664z)
## Authors
Expand All @@ -115,4 +115,4 @@ Shyam Deo ([email protected])
## Citation
For citation, refer to:
DOI: 10.1021/acs.iecr.4c03344
[[DOI: 10.1021/acs.iecr.4c03344](https://doi.org/10.1021/acs.iecr.4c03344)]

0 comments on commit 64a8b4e

Please sign in to comment.