Getting started

>>> from ResSimpy import NexusSimulator

A first step is typically to instantiate a Simulator object, passing in the location of the model you wish to work with. Here a Nexus Simulator model is instantiated.:

>>> model = NexusSimulator(origin=r'<address of model>')

You are then able to access and modify parts of the model as you wish. For example, to view an overview of all of the wells in a model you could call:

>>> print(model.Wells.get_wells_overview())

The full list of API calls available to you can be found in this documentation.