Skip to content

Commit

Permalink
Fix typos in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@oyvindeide @markusdregi
oyvindeide authored and markusdregi committed Aug 26, 2019
1 parent 9b9efdc commit 418dfb0
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 16 deletions.
6 changes: 3 additions & 3 deletions docs/rst/manual/keywords/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -64,12 +64,12 @@ Keyword name Required by
:ref:`CASE_TABLE <case_table>` NO For running sensitivities you can give the cases descriptive names
:ref:`CONTAINER <container>` NO ...
:ref:`CUSTOM_KW <custom_kw>` NO Ability to load arbitrary values from the forward model.
:ref:`DATA_FILE <data_file>` YES Provide an ECLIPSE data file for the problem.
:ref:`DATA_FILE <data_file>` NO Provide an ECLIPSE data file for the problem.
:ref:`DATA_KW <data_kw>` NO Replace strings in ECLIPSE .DATA files
:ref:`DBASE_TYPE <dbase_type>` NO BLOCK_FS Which 'database' system should be used for storage
:ref:`DEFINE <define>` NO Define keywords with config scope
:ref:`DELETE_RUNPATH <delete_runpath>` NO Explicitly tell ert to delete the runpath when a job is complete
:ref:`ECLBASE <eclbase>` YES Define a name for the ECLIPSE simulations.
:ref:`ECLBASE <eclbase>` YES* Define a name for the ECLIPSE simulations. *Either JOBNAME or ECLBASE must be specified
:ref:`END_DATE <end_date>` NO You can tell ERT how lon the simulations should be - for error check
:ref:`ENKF_ALPHA <enkf_alpha>` NO 1.50 Parameter controlling outlier behaviour in EnKF algorithm
:ref:`ENKF_BOOTSTRAP <enkf_bootstrap>` NO FALSE Should we bootstrap the Kalman gain estimate
Expand Down Expand Up @@ -101,7 +101,7 @@ Keyword name Required by
:ref:`ITER_CASE <iter_Case>` NO IES%d Case name format - iterated ensemble smoother
:ref:`ITER_COUNT <iter_count>` NO 4 Number of iterations - iterated ensemble smoother
:ref:`ITER_RETRY_COUNT <iter_retry_count>` NO 4 Number of retries for a iteration - iterated ensemble smoother
:ref:`JOBNAME <jobname>` NO Name used for simulation files. An alternative to ECLBASE.
:ref:`JOBNAME <jobname>` YES* Name used for simulation files. *Either JOBNAME or ECLBASE must be specified.
:ref:`JOB_SCRIPT <job_script>` NO Python script managing the forward model.
:ref:`LOAD_SEED <load_seed>` NO Load random seed from given file.
:ref:`LOAD_WORKFLOW <load_workflow>` NO Load a workflow into ERT.
Expand Down
23 changes: 12 additions & 11 deletions docs/rst/manual/observations/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -210,7 +210,7 @@ The GENERAL_OBSERVATION keyword is used together with the GEN_DATA and
GEN_PARAM type. This pair of observation and data types are typically
used when you want to update something special which does not fit into
any of the predefined types. The ERT application just treats
GENERAL_OBSERVATION (and also GEN_DATA) as a range of number with no
GENERAL_OBSERVATION (and also GEN_DATA) as a range of numbers with no
particular structure, this is very flexible, but of course also a bit
more complex to use::

Expand All @@ -220,16 +220,14 @@ more complex to use::
OBS_FILE = some_file.txt;
};

This example a minimum GENERAL_OBSERVATION. The keyword DATA points to
the GEN_DATA instance this observation is 'observing', RESTART gives
the report step when this observation is active. OBS_FILE should be
the name of a file with observation values, and the corresponding
uncertainties. The file with observations should just be a plain text
file with numbers in it, observations and corresponding uncertainties
interleaved. The file name / path is interperated relative to the ERT
main config file.

An example of an OBS_FILE::
This example shows a minimum GENERAL_OBSERVATION. The keyword DATA
points to the GEN_DATA instance this observation is 'observing',
RESTART gives the report step when this observation is active.
OBS_FILE should be the name of a file with observation values,
and the corresponding uncertainties. The file with observations should
just be a plain text file with numbers in it, observations and
corresponding uncertainties interleaved. An example of an OBS_FILE::

1.46 0.26
25.0 5.0
Expand Down Expand Up @@ -295,7 +293,10 @@ for GEN_OBS when specifying the time. So consider a setup like this::

Here we see that the observation is active at report step 20, and we
expect the forward model to create a file rft_BH67_20 in each
realization directory. Error covariance
realization directory.

Error covariance
.............................

ERROR_COVARIANCE keyword
........................
Expand Down
4 changes: 2 additions & 2 deletions docs/rst/manual/workflows/index.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ example of :code:`ErtScript` which calculates the misfit for all
observations and prints the result to a text file. All Python scripts
of this kind must:

1. Be implemented as a class which iherits from :code:`ErtScript`
1. Be implemented as a class which inherits from :code:`ErtScript`
2. Have a method :code:`run(self)` which does the actual job


Expand Down Expand Up @@ -155,7 +155,7 @@ If you wish to implement your job as a Python class, derived from
::

INTERNAL TRUE -- The job will call an internal function of the current running ERT instance.
SCRIPT sripts/my_script.py -- An existing Python script
SCRIPT scripts/my_script.py -- An existing Python script

Observe that the important thing here is the fact that we are writing
an *internal* Python script; if you are writing an external script to
Expand Down

0 comments on commit 418dfb0

Please sign in to comment.