Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
This commit updates the text in the README.md file, including the expected output of the command `$ pyvolcans --help`, as well as a brief description of the new plotting capabilities of `PyVOLCANS`, available from release `v1.1.0` onwards.
  • Loading branch information
PTierz authored Jun 4, 2021
1 parent 3c276d7 commit dba1ad3
Showing 1 changed file with 26 additions and 2 deletions.
28 changes: 26 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ $ pyvolcans --help
usage: pyvolcans [-h] [--apriori [APRIORI [APRIORI ...]]]
[-Ts TECTONIC_SETTING] [-G ROCK_GEOCHEMISTRY] [-M MORPHOLOGY]
[-Sz ERUPTION_SIZE] [-St ERUPTION_STYLE] [--count COUNT] [-w]
[-W] [-v] [-V]
[-W] [-v] [-pa] [-S] [-V]
volcano
positional arguments:
Expand All @@ -81,7 +81,11 @@ optional arguments:
-v, --verbose Print debug-level logging output, and include single-
criterion analogy values, besides the total analogy
values, in the PyVOLCANS results
-V, --version Show PyVOLCANS package version
-pa, --plot_apriori Generate bar plots displaying the values of single-
criterion and total analogy between the target volcano
and any 'a priori' analogues chosen by the user.
-S, --save_figures Save all generated figures
-V, --version Print PyVOLCANS package version and exit
```

### Default call to PyVOLCANS
Expand Down Expand Up @@ -329,6 +333,26 @@ with the expected data for the percentages of better analogues.
PLEASE USE either a set of volcano names or a set of volcano numbers to define
your set of a priori analogues when running PyVOLCANS. Many thanks.

#### Plotting capabilities

From release `v1.1.0` onwards, users can also visualise: (1) the single-criterion
and total (multi-criteria) analogy values between the target volcano and any _a priori_
analogue volcano selected by the user, and (2) the percentage of _better analogues_
(than each of the _a priori_ analogues) available in the whole GVP database, for the
specific target volcano chosen.

These results are provided as bar plots when the user selects the optional flag
`--plot_apriori` (or `-pa`):

```
$ pyvolcans Fuego --apriori Villarrica Llaima Pacaya Reventador Tungurahua --plot_apriori
```

If the user wants to save the generated figures (.png format, 600 dpi resolution),
the optional flag `--save_figures` (or `-S`) should be selected, together with the
`--plot_apriori` (or `-pa`) flag.


## Analogy matrices

In the original VOLCANS paper, the analogy matrices were calculated in Matlab.
Expand Down

0 comments on commit dba1ad3

Please sign in to comment.