From 23d8827355d724284ebd90998588093e99b90240 Mon Sep 17 00:00:00 2001 From: Lars Pastewka Date: Mon, 15 Jan 2024 14:00:43 +0100 Subject: [PATCH] DOC: Added a very simple getting started page --- docs/getting_started.rst | 26 ++++++++++++++++++++++++++ docs/index.rst | 4 ++-- 2 files changed, 28 insertions(+), 2 deletions(-) create mode 100644 docs/getting_started.rst diff --git a/docs/getting_started.rst b/docs/getting_started.rst new file mode 100644 index 00000000..b10bc6ce --- /dev/null +++ b/docs/getting_started.rst @@ -0,0 +1,26 @@ +`matscipy` +========== + +Matscipy is a generic materials science toolbox built around the `Atomic +Simulation Environment (ASE) `__. It provides +useful routines for electrochemistry, dislocations, fracture mechanics, tribology and others. + +Getting started +--------------- + +`matscipy` can used in two different modes: As a library in your own Python code or using the command-line interface. +The command-line interface implements specific workflows on top of the library. + +Using the library +~~~~~~~~~~~~~~~~~ + +As an example of how to use the programmatic interface, explore the +`computation of elastic constants `_ or how to +`build systems with cracks `_. + +Via the command-line interface +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The command line interface packages workflows. Common workflows include the +`computation of root-mean-square displacements for diffusion problems `_ or the +`quenching of amorphous structures `_. diff --git a/docs/index.rst b/docs/index.rst index d90543b5..93c9852b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,8 +1,8 @@ -.. include:: ../README.rst +.. include:: getting_started.rst .. toctree:: :maxdepth: 2 - :caption: Table of Contents: + :caption: Table of Contents self ./applications/index