Skip to content

Commit

Permalink
Minor changes to the documentation rst files
Browse files Browse the repository at this point in the history
  • Loading branch information
lisajulia committed Jun 26, 2024
1 parent 7e38734 commit eaffa1b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
4 changes: 3 additions & 1 deletion python/sphinx_docs/docs/embedded.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ In order to enable the PYACTION keyword:
.. code-block:: python
<PYACTION\_NAME> <SINGLE/UNLIMITED> /
<pythonscript> /
<pythonscript> / -- path to the python script, relative to the location of the DATA-file
3. You need to provide the Python script.

Expand Down Expand Up @@ -50,3 +50,5 @@ To interact with the simulator in the embedded Python code, you can access four
- current_report_step: This is an integer for the report step we are currently working on. Observe that the PYACTION is called for every simulator timestep, i.e. it will typically be called multiple times with the same value for the report step argument.

- current_summary_state: An instance of the `SummaryState <common.html#opm.io.sim.SummaryState>`_ class, this is where the current summary results of the simulator are stored. The SummaryState class has methods to get hold of well, group and general variables.

See also: PYACTION in the `reference manual <https://opm-project.org/?page_id=955>`_ for more information.
3 changes: 3 additions & 0 deletions python/sphinx_docs/docs/introduction.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,6 @@ Introduction
============

Documentation for the OPM Python interfaces.

#TODO: expand on the introduction, add information about installation and requirements for example. Some example code would also be nice.

0 comments on commit eaffa1b

Please sign in to comment.