Skip to content

Commit

Permalink
Add set_data_empty method to qc reset and edit init file (#121)
Browse files Browse the repository at this point in the history
Develop qcreset with docs and tests
  • Loading branch information
JiZur authored Apr 28, 2021
1 parent 7023298 commit a7fd80b
Show file tree
Hide file tree
Showing 4 changed files with 579 additions and 237 deletions.
51 changes: 25 additions & 26 deletions docs/qcreset.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,17 @@ Design philosophy
* The ``qcreset`` methods are meant to run inside RMS at the begining of
a modelling process


1. set_data_empty
-----------------
Method set_data_empty
---------------------


This method set all data described as input as empty. The data are not deleted
so that the geometry of the data (surfaces or 3D grid properties) should be
preserved and no workflow component (job or other) should be reset.


1.1. Signature
~~~~~~~~~~~~~~
Signature
~~~~~~~~~

The input of this method is a Python dictionary with defined keys. The key
"project" is required while "horizons", "zones" and "grid_models" are optional
Expand Down Expand Up @@ -64,21 +63,21 @@ grid_models



1.2. Known issues
~~~~~~~~~~~~~~~~~
Known issues
~~~~~~~~~~~~

* None for now


1.3. Examples to run from RMS
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Examples to run from RMS
~~~~~~~~~~~~~~~~~~~~~~~~

1.3.1. Example 1
^^^^^^^^^^^^^^^^
Example 1
^^^^^^^^^

.. code-block:: python
from fmu.tools import qcreset
from fmu.tools.rms import qcreset
import roxar
SETUP = {
Expand All @@ -104,8 +103,8 @@ grid_models
qcreset.set_data_empty(SETUP)
2. set_data_constant
--------------------
Method set_data_constant
------------------------


This method set all values of the data described as input to a constant.
Expand All @@ -115,8 +114,8 @@ component (job or other) is reset.
This method is more conservative than the ``set_data_empty`` method.


2.1. Signature
~~~~~~~~~~~~~~
Signature
~~~~~~~~~

The input of this method is a Python dictionary with defined keys. The keys
"project" and "value" are required while "horizons", "zones" and "grid_models"
Expand Down Expand Up @@ -161,21 +160,21 @@ grid_models



2.2. Known issues
~~~~~~~~~~~~~~~~~
Known issues
~~~~~~~~~~~~

* None for now


2.3. Examples to run from RMS
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Examples to run from RMS
~~~~~~~~~~~~~~~~~~~~~~~~

2.3.1. Example 1
^^^^^^^^^^^^^^^^
Example 1
^^^^^^^^^

.. code-block:: python
from fmu.tools import qcreset
from fmu.tools.rms import qcreset
import roxar
SETUP = {
Expand All @@ -202,12 +201,12 @@ grid_models
qcreset.set_data_constant(SETUP)
2.3.2. Example 2
^^^^^^^^^^^^^^^^
Example 2
^^^^^^^^^

.. code-block:: python
from fmu.tools import qcreset
from fmu.tools.rms import qcreset
import roxar
# We split the work into 2 different setups here in order to use different
Expand Down
Loading

0 comments on commit a7fd80b

Please sign in to comment.