OilfieldToolsNet/ResInsight
4
0
Fork 0
mirror of https://github.com/OPM/ResInsight.git synced 2025-02-25 18:55:39 -06:00
Code Issues Packages Projects Releases Wiki Activity

Python doc : Split into three python documents

Browse Source
This commit is contained in:
Magne Sjaastad 2019-09-03 10:55:51 +02:00
parent 70394f95e5
commit b287e2e128
2 changed files with 6 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
ApplicationCode/GrpcInterface/Python/doc/source/PythonRips.rst
View File

@ -1,2 +1,7 @@
.. include:: header.rst
+++
title = "Python API - rips"
published = true
weight = 42
+++
.. include:: rips.rst

20
ApplicationCode/GrpcInterface/Python/doc/source/header.rst
View File

@ -1,20 +0,0 @@
+++
title = "Python API - rips"
published = true
weight = 40
+++
ResInsight has a `gRPC Remote Procedure Call <https://www.grpc.io/>`_ interface with a Python Client interface. This interface allows you to interact with a running ResInsight instance from a Python script.
The Python client package is available for install via the Python PIP package system with ``pip install rips`` as admin user, or ``pip install --user rips`` as a regular user.
On some systems the ``pip`` command may have to be replaced by ``python -m pip``.
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 the About dialog confirming gRPC is available:
.. image:: {{< relref "" >}}images/scripting/AboutGrpc.png
Furthermore, gRPC needs to be enabled in the Scripting tab of the Preference dialog:
.. image:: {{< relref "" >}}images/scripting/PrefGrpc.png