From aba45021c6288ade53095340a3c2a208af52aa49 Mon Sep 17 00:00:00 2001 From: SunyongKwon Date: Wed, 22 May 2024 17:29:24 -0400 Subject: [PATCH] Update documentation --- docs/index.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/index.md b/docs/index.md index 591a2ef..bbb36c7 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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`. @@ -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). @@ -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/ \ No newline at end of file +[polars]: https://docs.pola.rs/ +[examples]: https://github.com/ORNL/Equilipy/blob/main/example \ No newline at end of file