Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/geos-ats.rst
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@

GEOS ATS
ATS
==========

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


run_geos_ats
----------------
Usage
--------

Primary entry point for running integrated tests.
`run_geos_ats` is the primary entry point for running integrated tests.

.. argparse::
:module: geos.ats.command_line_parsers
Expand Down
10 changes: 0 additions & 10 deletions docs/geos-geomechanics.rst

This file was deleted.

13 changes: 0 additions & 13 deletions docs/geos-processing.rst

This file was deleted.

16 changes: 0 additions & 16 deletions docs/geos-pv.rst

This file was deleted.

39 changes: 39 additions & 0 deletions docs/geos-timehistory.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,44 @@
Time History Tools
--------------------------

The `geos-timehistory` package contains tools to treat and plot time-history data from GEOS output.

Usage
^^^^^^^^

.. code-block:: bash

$ python plot_time_history.py --help

usage: plot_time_history.py [-h] [--sets name [name ...]]
[--indices index [index ...]]
[--components int [int ...]]
history_file variable_name

A script that parses geosx HDF5 time-history files and produces time-history
plots using matplotlib

positional arguments:
history_file The time history file to parse
variable_name Which time-history variable collected by GEOSX to
generate a plot file for.

options:
-h, --help show this help message and exit
--sets name [name ...]
Which index set of time-history data collected by GEOS
to generate a plot file for, may be specified multiple
times with different indices/components for each set.
--indices index [index ...]
An optional list of specific indices in the most-
recently specified set.
--components int [int ...]
An optional list of specific variable components


API
^^^^

.. automodule:: geos.timehistory.plot_time_history
:members:

29 changes: 14 additions & 15 deletions docs/geos-utils.rst
Original file line number Diff line number Diff line change
@@ -1,73 +1,72 @@

GEOS Utilities
Utilities
===============

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


API
^^^

geos.utils.ConnectionSet module
ConnectionSet module
--------------------------------

.. automodule:: geos.utils.ConnectionSet
:members:
:undoc-members:
:show-inheritance:

geos.utils.enumUnits module
enumUnits module
--------------------------------

.. automodule:: geos.utils.enumUnits
:members:
:undoc-members:
:show-inheritance:
geos.utils.geometryFunctions module

geometryFunctions module
------------------------------------

.. automodule:: geos.utils.geometryFunctions
:members:
:undoc-members:
:show-inheritance:

geos.utils.GeosOutputsConstants module

GeosOutputsConstants module
-------------------------------------------

.. automodule:: geos.utils.GeosOutputsConstants
:members:
:undoc-members:
:show-inheritance:

geos.utils.algebraFunctions module
algebraFunctions module
-------------------------------------------

.. automodule:: geos.utils.algebraFunctions
:members:
:undoc-members:
:show-inheritance:

geos.utils.Logger module
Logger module
------------------------------

.. automodule:: geos.utils.Logger
:members:
:undoc-members:
:show-inheritance:

geos.utils.PhysicalConstants module
.. _output-constant:

PhysicalConstants module
-----------------------------------------

.. automodule:: geos.utils.PhysicalConstants
:members:
:undoc-members:
:show-inheritance:

geos.utils.UnitRepository module
UnitRepository module
-------------------------------------

.. automodule:: geos.utils.UnitRepository
:members:
:undoc-members:
:show-inheritance:
:show-inheritance:
12 changes: 12 additions & 0 deletions docs/geos_geomechanics_docs/geos-geomechanics.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
GEOS Geomechanics tools
=============================

This package contains geomechanics functions and data models.

.. toctree::
:maxdepth: 2
:caption: Contents:

model

processing
4 changes: 0 additions & 4 deletions docs/geos_geomechanics_docs/home.rst

This file was deleted.

12 changes: 6 additions & 6 deletions docs/geos_geomechanics_docs/model.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
Geomechanics models
======================
Models
=============

This module defines data structures for geomechanics calculations.

geos.geomechanics.model.MohrCircle module
------------------------------------------
Mohr circle
-----------------

.. automodule:: geos.geomechanics.model.MohrCircle
:members:
:undoc-members:
:show-inheritance:

geos.geomechanics.model.MohrCoulomb module
-------------------------------------------
Mohr-Coulomb failure envelop
-------------------------------

.. automodule:: geos.geomechanics.model.MohrCoulomb
:members:
Expand Down
10 changes: 0 additions & 10 deletions docs/geos_geomechanics_docs/modules.rst

This file was deleted.

4 changes: 2 additions & 2 deletions docs/geos_geomechanics_docs/processing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ Processing

The processing part of `geos-geomechanics` package contains the basis functions to compute geomechanical properties.

geos.geomechanics.processing.geomechanicsCalculatorFunctions module
---------------------------------------------------------------------
Geomechanical properties
-----------------------------------

.. automodule:: geos.geomechanics.processing.geomechanicsCalculatorFunctions
:members:
Expand Down
10 changes: 5 additions & 5 deletions docs/geos-mesh.rst → docs/geos_mesh_docs/geos-mesh.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,12 @@ GEOS Mesh tools
:maxdepth: 1
:caption: Contents:

./geos_mesh_docs/converter
./converter

./geos_mesh_docs/io
./io

./geos_mesh_docs/model
./model

./geos_mesh_docs/stats
./stats

./geos_mesh_docs/utils
./utils
24 changes: 12 additions & 12 deletions docs/geos_processing_docs/generic_processing_tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,53 +4,53 @@ Generic processing filters
The `generic_processing_tools` module of `geos-processing` package contains filters to process meshes.


geos.processing.generic_processing_tools.AttributeMapping filter
----------------------------------------------------------------
AttributeMapping
---------------------

.. automodule:: geos.processing.generic_processing_tools.AttributeMapping
:members:
:undoc-members:
:show-inheritance:


geos.processing.generic_processing_tools.CreateConstantAttributePerRegion filter
--------------------------------------------------------------------------------
CreateConstantAttributePerRegion
--------------------------------------

.. automodule:: geos.processing.generic_processing_tools.CreateConstantAttributePerRegion
:members:
:undoc-members:
:show-inheritance:


geos.processing.generic_processing_tools.FillPartialArrays filter
-----------------------------------------------------------------
FillPartialArrays
------------------------

.. automodule:: geos.processing.generic_processing_tools.FillPartialArrays
:members:
:undoc-members:
:show-inheritance:


geos.processing.generic_processing_tools.SplitMesh filter
---------------------------------------------------------
SplitMesh
-------------------------

.. automodule:: geos.processing.generic_processing_tools.SplitMesh
:members:
:undoc-members:
:show-inheritance:


geos.processing.generic_processing_tools.MergeBlockEnhanced filter
------------------------------------------------------------------
MergeBlockEnhanced
----------------------------------

.. automodule:: geos.processing.generic_processing_tools.MergeBlockEnhanced
:members:
:undoc-members:
:show-inheritance:


geos.processing.generic_processing_tools.ClipToMainFrame filter
---------------------------------------------------------------
ClipToMainFrame
------------------------------

.. automodule:: geos.processing.generic_processing_tools.ClipToMainFrame
:members:
Expand Down
14 changes: 14 additions & 0 deletions docs/geos_processing_docs/geos-processing.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
Processing tools
========================

The `geos-processing` package contains different tools to prepare, post-process or analyze GEOS data, from surface geomechanics calculation to attribute mapping from one mesh to another.

.. toctree::
:maxdepth: 2
:caption: Contents:

generic_processing_tools.rst

pre_processing.rst

post_processing.rst
Loading