From da10eed84edb764efa539a21117e16bf0fc2e8a0 Mon Sep 17 00:00:00 2001 From: Sylvain Tricot Date: Tue, 19 Apr 2022 16:23:52 +0200 Subject: [PATCH] Update install instructions --- INSTALL.md | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) diff --git a/INSTALL.md b/INSTALL.md index 46bc1db..3026022 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -43,3 +43,42 @@ Uninstalling ``` $ pip uninstall msspec_dfm ``` + + + +Running the code +================ + +The program can be run either from the command line or from a Python script. + +Command-line +------------ + +The executable is called 'eps'. Type in 'man eps' to get more help. It has 3 main sub-commands: + +- generate +- compute +- plot + +Begin by generating an input file with default values: + +``` +$ eps generate +``` + +Then, edit this input file according to your needs and compute + +``` +$ eps compute Data/epsilon.dat +``` + +Finally you can plot the results + +``` +$ eps plot diel_func +``` + +Python bindings +--------------- + +Have a look to [this example](./examples/example00.py)