Skip to content

Commit 19bbbf6

Browse files
docs: Update the online documentation (#196)
1 parent 6f507af commit 19bbbf6

File tree

69 files changed

+384
-1006
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+384
-1006
lines changed

docs/geos-ats.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11

2-
GEOS ATS
2+
ATS
33
==========
44

55
The `geos-ats` python package includes tools for managing integrated tests for GEOS.
66
It is built using the `Automated Test System <https://ats.readthedocs.io/en/latest/>`_ (ATS) package.
77
The available console scripts for this package and its API are described below.
88

99

10-
run_geos_ats
11-
----------------
10+
Usage
11+
--------
1212

13-
Primary entry point for running integrated tests.
13+
`run_geos_ats` is the primary entry point for running integrated tests.
1414

1515
.. argparse::
1616
:module: geos.ats.command_line_parsers

docs/geos-geomechanics.rst

Lines changed: 0 additions & 10 deletions
This file was deleted.

docs/geos-processing.rst

Lines changed: 0 additions & 13 deletions
This file was deleted.

docs/geos-pv.rst

Lines changed: 0 additions & 16 deletions
This file was deleted.

docs/geos-timehistory.rst

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,44 @@
22
Time History Tools
33
--------------------------
44

5+
The `geos-timehistory` package contains tools to treat and plot time-history data from GEOS output.
6+
7+
Usage
8+
^^^^^^^^
9+
10+
.. code-block:: bash
11+
12+
$ python plot_time_history.py --help
13+
14+
usage: plot_time_history.py [-h] [--sets name [name ...]]
15+
[--indices index [index ...]]
16+
[--components int [int ...]]
17+
history_file variable_name
18+
19+
A script that parses geosx HDF5 time-history files and produces time-history
20+
plots using matplotlib
21+
22+
positional arguments:
23+
history_file The time history file to parse
24+
variable_name Which time-history variable collected by GEOSX to
25+
generate a plot file for.
26+
27+
options:
28+
-h, --help show this help message and exit
29+
--sets name [name ...]
30+
Which index set of time-history data collected by GEOS
31+
to generate a plot file for, may be specified multiple
32+
times with different indices/components for each set.
33+
--indices index [index ...]
34+
An optional list of specific indices in the most-
35+
recently specified set.
36+
--components int [int ...]
37+
An optional list of specific variable components
38+
39+
40+
API
41+
^^^^
42+
543
.. automodule:: geos.timehistory.plot_time_history
644
:members:
45+

docs/geos-utils.rst

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,73 +1,72 @@
1-
2-
GEOS Utilities
1+
Utilities
32
===============
43

54
The `geos-utils` python package defines utilities for all GEOS python packages including a logger, GEOS constants, basic functions, and unit management tools.
65

76

8-
API
9-
^^^
10-
11-
geos.utils.ConnectionSet module
7+
ConnectionSet module
128
--------------------------------
139

1410
.. automodule:: geos.utils.ConnectionSet
1511
:members:
1612
:undoc-members:
1713
:show-inheritance:
1814

19-
geos.utils.enumUnits module
15+
enumUnits module
2016
--------------------------------
2117

2218
.. automodule:: geos.utils.enumUnits
2319
:members:
2420
:undoc-members:
2521
:show-inheritance:
26-
27-
geos.utils.geometryFunctions module
22+
23+
geometryFunctions module
2824
------------------------------------
2925

3026
.. automodule:: geos.utils.geometryFunctions
3127
:members:
3228
:undoc-members:
3329
:show-inheritance:
3430

35-
geos.utils.GeosOutputsConstants module
31+
32+
GeosOutputsConstants module
3633
-------------------------------------------
3734

3835
.. automodule:: geos.utils.GeosOutputsConstants
3936
:members:
4037
:undoc-members:
4138
:show-inheritance:
4239

43-
geos.utils.algebraFunctions module
40+
algebraFunctions module
4441
-------------------------------------------
4542

4643
.. automodule:: geos.utils.algebraFunctions
4744
:members:
4845
:undoc-members:
4946
:show-inheritance:
5047

51-
geos.utils.Logger module
48+
Logger module
5249
------------------------------
5350

5451
.. automodule:: geos.utils.Logger
5552
:members:
5653
:undoc-members:
5754
:show-inheritance:
5855

59-
geos.utils.PhysicalConstants module
56+
.. _output-constant:
57+
58+
PhysicalConstants module
6059
-----------------------------------------
6160

6261
.. automodule:: geos.utils.PhysicalConstants
6362
:members:
6463
:undoc-members:
6564
:show-inheritance:
6665

67-
geos.utils.UnitRepository module
66+
UnitRepository module
6867
-------------------------------------
6968

7069
.. automodule:: geos.utils.UnitRepository
7170
:members:
7271
:undoc-members:
73-
:show-inheritance:
72+
:show-inheritance:
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
GEOS Geomechanics tools
2+
=============================
3+
4+
This package contains geomechanics functions and data models.
5+
6+
.. toctree::
7+
:maxdepth: 2
8+
:caption: Contents:
9+
10+
model
11+
12+
processing

docs/geos_geomechanics_docs/home.rst

Lines changed: 0 additions & 4 deletions
This file was deleted.

docs/geos_geomechanics_docs/model.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,18 @@
1-
Geomechanics models
2-
======================
1+
Models
2+
=============
33

44
This module defines data structures for geomechanics calculations.
55

6-
geos.geomechanics.model.MohrCircle module
7-
------------------------------------------
6+
Mohr circle
7+
-----------------
88

99
.. automodule:: geos.geomechanics.model.MohrCircle
1010
:members:
1111
:undoc-members:
1212
:show-inheritance:
1313

14-
geos.geomechanics.model.MohrCoulomb module
15-
-------------------------------------------
14+
Mohr-Coulomb failure envelop
15+
-------------------------------
1616

1717
.. automodule:: geos.geomechanics.model.MohrCoulomb
1818
:members:

docs/geos_geomechanics_docs/modules.rst

Lines changed: 0 additions & 10 deletions
This file was deleted.

0 commit comments

Comments
 (0)