-
Notifications
You must be signed in to change notification settings - Fork 54
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
DOC: Added a very simple getting started page
- Loading branch information
Showing
2 changed files
with
28 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
`matscipy` | ||
========== | ||
|
||
Matscipy is a generic materials science toolbox built around the `Atomic | ||
Simulation Environment (ASE) <https://wiki.fysik.dtu.dk/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 <applications/elastic_constants.html>`_ or how to | ||
`build systems with cracks <applications/fracture_mechanics.html>`_. | ||
|
||
Via the command-line interface | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
The command line interface packages workflows. Common workflows include the | ||
`computation of root-mean-square displacements for diffusion problems <cli/diffusion.html>`_ or the | ||
`quenching of amorphous structures <cli/structure.html>`_. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters