Skip to content

Commit

Permalink
tweak main README
Browse files Browse the repository at this point in the history
  • Loading branch information
DanielYang59 committed Apr 3, 2024
1 parent 96ba966 commit 565790e
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
[![codecov](https://codecov.io/gh/DanielYang59/cat-scaling/graph/badge.svg?token=QZCC05D7L4)](https://codecov.io/gh/DanielYang59/cat-scaling)

> [!WARNING]
> Results generated using this code have not undergone thorough validation.\
> Any assistance in verifying the results would be greatly appreciated.
> Results generated using this code have not undergone thorough validation.
> Assistance in verifying the results would be greatly appreciated.
> [!WARNING]
> This project is currently in its initial stages and is being actively updated.\
> This project is currently in its initial stages and is being actively updated.
> Various parts might be missing, and frequent (breaking) changes are expected.
`cat-scaling` is a handy package for building [catalysts scaling relations](https://pubs.acs.org/doi/10.1021/jz201461p) and visualizing the results with volcano plots.
Expand All @@ -19,9 +19,9 @@ The documentation is currently under development. Thank you for your patience.
## Example

You can find examples in the `examples` directory of this repository:
- [Traditional(Single Descriptor) Builder](./examples/traditional.ipynb).

- (In progress)[Adaptive Builder](./examples/adaptive.ipynb)
- [Traditional (Single Descriptor) Builder](./examples/traditional.ipynb).
- (In progress) [Adaptive Builder](./examples/adaptive.ipynb)

## License

Expand Down

0 comments on commit 565790e

Please sign in to comment.