Welcome to ResSimpy's documentation
===================================

ResSimpy is a Python library which provides a programming interface (API) for
reading and modifying reservoir simulator models. It is an Open Source project with the long term goal of allowing straightforward conversion between simulator formats.

The repository is hosted on `GitHub <https://github.com/bp/ResSimpy>`_.

.. toctree::
   :maxdepth: 1
   :caption: About

   installation
   getting_started
   CONTRIBUTING
   
API Reference
-------------

.. automodule:: ResSimpy


Indices and tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`