Skip to main content

A Python library for working with Reservoir Simulator Models.

Project description

ResSimpy: Python API for working with Reservoir Simulator models

License Documentation Status Python CI Python version PyPI Status codecov

Introduction

ResSimpy is a Python API for automating reservoir simulation workflows, allowing the user to read, manipulate and write reservoir simulation input decks. Whilst it was created by staff at BP, we welcome contributions from anybody interested, whether it is by raising pull requests, or simply suggesting features / raising bugs in the GitHub issues.

Documentation

See the complete package documentation on readthedocs.

Installation

ResSimpy can be installed with pip:

pip install ressimpy

Contributing

Please see Contributing Guide for instructions on how to set up a dev environment and contribute code to the project.

Getting Started

The following Python code examples demonstrate how to perform some simple operations on a model using ResSimpy:

Step 1: Import the library

from ResSimpy import NexusSimulator as Simulator

Step 2: Initialise the model

nexus_fcs_file = '/path/to/fcsfile.fcs'
model = Simulator(origin=nexus_fcs_file) # Create the 'Simulator' model object

Once these steps are completed, you are able to perform any supported operations on the model. The following code snippets are examples of a few such operations:

Writing Out Files

# Update the files in the model that have been modified.
# IMPORTANT: no changes made to the model, such as adding completions or removing constraints will be applied to the model files until this function is called.
model.update_simulator_files()

# Create a copy of the entire model
model.write_out_new_simulator(new_file_path='/new/path/to/fcsfile.fcs', new_include_file_location='/new/path/to/includes_directory/')

Wells - Get wells overview

wells_info = model.wells.get_wells_overview() # Returns a list of wells with their information. Can be print()ed
print(wells_info)

Wells - Get information about an individual Well

well = model.wells.get(well_name='well_1') # Retrieves the named well as a NexusWell object

# You can then access the various properties for that well (such as perforations, shutins, completion events etc) using (for example)
perforations = well.perforations

# You can pretty print the information about a well using
print(well.printable_well_info)

# Get the wells information in dataframe format
wells_df = model.wells.get_df()
print(wells_df)

Completions

# Adding a completion
new_completion = {'date': '01/02/2025', 'i': 4, 'j': 5, 'k': 6, 'well_radius': 7.50} # Create a dictionary containing the properties of the completion you wish to add
model.wells.add_completion(well_name='well_1', completion_properties=new_completion) # Add the new completion

# Removing a completion
completion_to_modify = {'date': '01/02/2025', 'i': 4, 'j': 5, 'k': 6, 'well_radius': 7.5} # Create a dictionary containing the properties of the existing completion
model.wells.remove_completion(well_name='well_1', completion_properties=completion_to_modify) # Remove the completion

# Modifying a completion
modified_properties = {'date': '10/03/2025'} # Create a dict with the properties you want to change and their new values
model.wells.modify_completion(well_name='well_1', properties_to_modify=modified_properties, completion_to_change=completion_to_modify) # Modify the completion

Structured Grid - Get a list of the array functions applied to the grid

func_list = model.grid.get_array_functions_list()
func_summary_df = model.grid.get_array_functions_df() # get a dataframe instead

[print(x) for x in func_list[0:9]] # Example showing how to print out the first 10 functions

Networks - Get constraints

constraints = model.network.constraints.get_all()
constraints_for_well = constraints['well_1'] # Get the constraints for the well well_1

# You can then access various properties related to the constraints, such as oil, water and gas rates using
oil_rate = constraints_for_well[0].max_surface_oil_rate
print(f"\nmax surface oil rate: {oil_rate}")

# Get a dataframe with all constraints in it.
constraint_df = model.network.constraints.get_df()
print(constraint_df)

Networks - Get dataframes of well connections, wellbores, network connections and nodes

df_well_cons = model.network.connections.get_df()
df_well_bores = model.network.wellbores.get_df()
df_connections = model.network.connections.get_df()
df_nodes = model.network.nodes.get_df()

Support

For most bugs or feature requests, we recommend using GitHub issues. If, however, you have a query related to something else, or if your query relates to something confidential, please feel free to email the team at ResSimpy@bp.com.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ressimpy-2.3.6.tar.gz (237.4 kB view details)

Uploaded Source

Built Distribution

ressimpy-2.3.6-py3-none-any.whl (340.8 kB view details)

Uploaded Python 3

File details

Details for the file ressimpy-2.3.6.tar.gz.

File metadata

  • Download URL: ressimpy-2.3.6.tar.gz
  • Upload date:
  • Size: 237.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for ressimpy-2.3.6.tar.gz
Algorithm Hash digest
SHA256 1daf798ece996dc9292a305e1adcac34c085c198d82fd607ae07161501f2610f
MD5 d7bba2ce737e7d85d5328850f63d800c
BLAKE2b-256 636b97cc96c570f911f3aa1bae50c492990796a07560e11c735579acc7cad4c5

See more details on using hashes here.

Provenance

The following attestation bundles were made for ressimpy-2.3.6.tar.gz:

Publisher: ci-publish.yml on bp/ResSimpy

Attestations:

File details

Details for the file ressimpy-2.3.6-py3-none-any.whl.

File metadata

  • Download URL: ressimpy-2.3.6-py3-none-any.whl
  • Upload date:
  • Size: 340.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for ressimpy-2.3.6-py3-none-any.whl
Algorithm Hash digest
SHA256 280c57ac26bd0720beec4c0835a3273686d04e77a468aefd9c43890572edda02
MD5 c0a57e525444b0374f6fe3535421449b
BLAKE2b-256 1779472d5298a5d7a42c1a9a69d20fcd2ee8c0b10dcd57496b26cdc1b9f390d0

See more details on using hashes here.

Provenance

The following attestation bundles were made for ressimpy-2.3.6-py3-none-any.whl:

Publisher: ci-publish.yml on bp/ResSimpy

Attestations:

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page