mirror of
https://github.com/OPM/ResInsight.git
synced 2025-02-25 18:55:39 -06:00
Rework overarching info and addition of installation and config
This commit is contained in:
parent
7b22bd2ea8
commit
594e0163bd
38
docs/source/Installation.rst
Normal file
38
docs/source/Installation.rst
Normal file
@ -0,0 +1,38 @@
|
|||||||
|
Installation and Configuration
|
||||||
|
==============================
|
||||||
|
|
||||||
|
.. image:: images/python-logo-master-v3-TM.png
|
||||||
|
|
||||||
|
The ResInsight Python API is compatible with `Python 3 <https://www.python.org/download/releases/3.0/>`_.
|
||||||
|
As admin user, the necessary Python client package is available for install via the Python PIP package system:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
pip install rips
|
||||||
|
|
||||||
|
or as a regular user:
|
||||||
|
|
||||||
|
.. code-block:: console
|
||||||
|
|
||||||
|
pip install --user rips
|
||||||
|
|
||||||
|
On some systems the `pip` command may have to be replaced by `python -m pip`.
|
||||||
|
|
||||||
|
The ResInsight Python API is based on `gRPC <https://www.grpc.io/>`_ remote procedure calls.
|
||||||
|
In order for gRPC to be available, ResInsight needs to be built with the **RESINSIGHT_ENABLE_GRPC** option set.
|
||||||
|
A valid gRPC build will show a message in ResInsight *About* dialog confirming gRPC is available.
|
||||||
|
|
||||||
|
.. image:: images/AboutGrpc.png
|
||||||
|
|
||||||
|
Furthermore, gRPC needs to be enabled in the *Scripting* tab of the ResInsight *Preference* dialog:
|
||||||
|
|
||||||
|
.. image:: images/PrefGrpc.png
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
@ -20,7 +20,7 @@ sys.path.insert(0, os.path.abspath('..'))
|
|||||||
|
|
||||||
# -- Project information -----------------------------------------------------
|
# -- Project information -----------------------------------------------------
|
||||||
|
|
||||||
project = 'ResInsight Scripting API'
|
project = 'ResInsight Python API'
|
||||||
copyright = '2020, Ceetron Solutions AS'
|
copyright = '2020, Ceetron Solutions AS'
|
||||||
author = 'Ceetron Solutions AS'
|
author = 'Ceetron Solutions AS'
|
||||||
|
|
||||||
|
BIN
docs/source/images/AboutGrpc.png
Normal file
BIN
docs/source/images/AboutGrpc.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 11 KiB |
BIN
docs/source/images/PrefGrpc.png
Normal file
BIN
docs/source/images/PrefGrpc.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 18 KiB |
@ -1,9 +1,17 @@
|
|||||||
ResInsight Scripting API
|
ResInsight Python API
|
||||||
========================
|
=====================
|
||||||
|
|
||||||
Many features of ResInsigt can automated using the Python API
|
The ResInsight Python API allows you to interact with a running ResInsight instance from `Python 3 <https://www.python.org/download/releases/3.0/>`_.
|
||||||
|
This enables you to:
|
||||||
|
|
||||||
See https://resinsight.org for the main **ResInsight** documentation.
|
* start ResInsight from Python
|
||||||
|
* communicate with an a running ResInsight instance
|
||||||
|
* load a ResInsight project file
|
||||||
|
* load data files such as Eclipse EGRID files and summary files
|
||||||
|
* extract data to Python for further processing and automation
|
||||||
|
* export snapshots of graphics
|
||||||
|
|
||||||
|
Please refer to https://resinsight.org for documentation on the graphical user interface, features and capabilites of **ResInsight**.
|
||||||
|
|
||||||
Contents
|
Contents
|
||||||
========
|
========
|
||||||
@ -11,6 +19,7 @@ Contents
|
|||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 1
|
:maxdepth: 1
|
||||||
|
|
||||||
|
Installation
|
||||||
PythonExamples
|
PythonExamples
|
||||||
rips
|
rips
|
||||||
pdm_objects
|
pdm_objects
|
||||||
|
Loading…
Reference in New Issue
Block a user