How bp/resqpy works
resqpy is a Python API for reading, writing, and modifying RESQML reservoir models. The principal workflow is to open or create a model, import or construct model objects, work with grids and associated geology, wells, and properties, then persist the result. The map includes documented import and derived-model capabilities. Storage details and several subsystem connections are represented conservatively: only sampled excerpts support specific call edges, so unsampled wiring is not expanded.
Main entry points: _model.py Model API · _grid.py IJK grids · _context.py Model context · _find_faces.py Surface-grid intersections
Components 22
Model and storage
- Model context
resqpy/model/_context.py - Model API
resqpy/model/_model.py - XML model data
resqpy/model/_xml.py - HDF5 arrays
resqpy/model/_hdf5.py
Grid and properties
- Derived models
resqpy/derived_model - IJK grids
resqpy/grid/_grid.py - Unstructured grids
resqpy/unstructured/_unstructured_grid.py - Property collections
resqpy/property/property_collection.py - Grid connections
resqpy/fault/_grid_connection_set.py - Transmissibility
resqpy/olio/transmission.py
Geology and geometry
- Surfaces
resqpy/surface/_surface.py - Surface-grid intersections
resqpy/grid_surface/_find_faces.py - Fault interpretation
resqpy/organize/fault_interpretation.py - Stratigraphy
resqpy/strata/_stratigraphic_column.py
Wells and import
- Format import
resqpy/rq_import - Well trajectories
resqpy/well/_trajectory.py - Blocked wells
resqpy/well/_blocked_well.py - Well properties
resqpy/property/well_interval_property_collection.py
Model support
- Coordinate systems
resqpy/crs.py - Time series
resqpy/time_series/_time_series.py - Units and measures
resqpy/weights_and_measures/weights_and_measures.py
Other components
- API user
Connections 22
- API user → Model context: opens model
- Model context → Model API: creates or opens
- Model context → Model API: stores on exit
- Model API → XML model data: manages XML
- Model API → HDF5 arrays: manages arrays
- API user → Format import: imports data
- API user → Derived models: derives models
- API user → IJK grids: works with grids
- API user → Unstructured grids: works with grids
- IJK grids → HDF5 arrays: writes geometry
- IJK grids → Property collections: exposes properties
- Unstructured grids → Property collections: exposes properties
- Blocked wells → Well properties: adds well properties
- Blocked wells → Time series: creates time series
- Surface-grid intersections → Coordinate systems: converts coordinates
- Surface-grid intersections → IJK grids: intersects grid
- API user → Surfaces: works with surfaces
- API user → Grid connections: works with connections
- API user → Well trajectories: works with wells
- API user → Fault interpretation: organizes geology
- API user → Stratigraphy: defines stratigraphy
- API user → Transmissibility: calculates flow