Files
ResInsight/docs/source/index.rst
Gaute Lindkvist 2f3c950110 Update index.rst
2020-04-17 11:27:10 +02:00

42 lines
1.1 KiB
ReStructuredText

ResInsight 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:
* start ResInsight from Python
* communicate with 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
Documentation Sites
===================
Please refer to https://resinsight.org for documentation on the graphical user interface, features and capabilites of **ResInsight**.
* `resinsight.org <https://resinsight.org>`_ - Documentation for latest stable release
* `api.resinsight.org <https://api.resinsight.org>`_ - Documentation of Python API
* `beta.resinsight.org <https://beta.resinsight.org>`_ - Latest documentation (not yet released)
Contents
========
.. toctree::
:maxdepth: 1
Installation
PythonExamples
rips
pdm_objects
commands
Indices and tables
==================
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`