Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
SunyongKwon committed May 22, 2024
1 parent ddd3a5b commit aba4502
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,6 @@ nav_order: 1
[View Equilipy on GitHub][equilipy]{: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-2 }

---

## Getting started

For details, check out [Features and example][features].
Running the first example is as simple as:

## Quick Installation

Installation using `pip` is available for `equilipy`.
Expand All @@ -34,6 +28,17 @@ For detailed information, please see [Install][install].
{: .warning }
`equilipy` requires a Fortran compiler in the local environment. To install a Fortran compiler, please follow [Preinstall][preinstall].


## Getting started
Example python scripts are given in [Example][examples]. Running the example files are as simple as

```
python Example01_SingleEquilib.py
```

For details, check out [Features and example][features].


## About the project

Euqilipy is © 2024-{{ "now" | date: "%Y" }} by [U.S. Department of Energy](https://doi.org/10.11578/dc.20240312.4).
Expand All @@ -58,4 +63,5 @@ our community a poisitive experiences for everyone.
[preinstall]: https://ornl.github.io/Equilipy/preinstall.html
[install]: https://ornl.github.io/Equilipy/install.html
[features]: https://ornl.github.io/Equilipy/features.html
[polars]: https://docs.pola.rs/
[polars]: https://docs.pola.rs/
[examples]: https://github.com/ORNL/Equilipy/blob/main/example

0 comments on commit aba4502

Please sign in to comment.