From eaffa1b97f6751933fc7b96e901f58b147fce4bc Mon Sep 17 00:00:00 2001 From: Lisa Julia Nebel Date: Mon, 24 Jun 2024 16:31:26 +0200 Subject: [PATCH] Minor changes to the documentation rst files --- python/sphinx_docs/docs/embedded.rst | 4 +++- python/sphinx_docs/docs/introduction.rst | 3 +++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/python/sphinx_docs/docs/embedded.rst b/python/sphinx_docs/docs/embedded.rst index 85d176fad25..011c99ba218 100644 --- a/python/sphinx_docs/docs/embedded.rst +++ b/python/sphinx_docs/docs/embedded.rst @@ -22,7 +22,7 @@ In order to enable the PYACTION keyword: .. code-block:: python / - / + / -- path to the python script, relative to the location of the DATA-file 3. You need to provide the Python script. @@ -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 `_ 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 `_ for more information. diff --git a/python/sphinx_docs/docs/introduction.rst b/python/sphinx_docs/docs/introduction.rst index 40d6af621a0..5b8bb5c258a 100644 --- a/python/sphinx_docs/docs/introduction.rst +++ b/python/sphinx_docs/docs/introduction.rst @@ -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. +