Setup#

To start using the Production Studio, follow these steps to set up the environment and install the synmax-api-python-client.

Prerequisites#

Before you begin, ensure you have the following prerequisites.

  • Python 3.10 or higher

  • pip (Python package installer)

Installation#

Follow these steps to install the necessary dependencies.

  1. Install the Synmax API Client

Install the Synmax API Client with the following command.

pip install --upgrade synmax-api-python-client

Start using the production studio#

Follow these steps to initialize and set up the Synmax API client to start using the production studio:

  1. Import Essential Libraries

Run this block of code at the beginning of your script to import the required libraries and set up the environment for the application.

import logging
from synmax.hyperion import ApiPayload, HyperionApiClient
from synmax.hyperion.create_simulation import Production_Simulation

  1. Setting Up Client and Query Payload

Initialize the Hyperion API client and create the payload needed for making API requests, along with setting the necessary parameters for the simulation.

# Set up logging
logging.basicConfig(format='%(asctime)s %(levelname)s:%(message)s', level=logging.INFO)
logger = logging.getLogger("CREATE_SIMULATION")

# Initialize the Hyperion API client
access_token = "YOUR_ACCESS_TOKEN"
client = HyperionApiClient(access_token=access_token)

# Create the payload for the API call
payload = ApiPayload(
    start_date="2021-01-01",
    sub_region=["OH"],
)

# Initialize the Production_Simulation class
simulation = Production_Simulation(client=client, payload=payload)

Output: The logs will display the status of the API client and simulation setup, confirming the initialization.

INFO:ApiClient initialized successfully.
INFO:Processed payload: pagination_start=0 start_date='2021-01-01' end_date=None forecast_run_date=None production_month=None first_production_month_start=None first_production_month_end=None state_code=None region=None sub_region=['OH'] county=None operator=None api=None aggregate_by=None aggregation_type=None service_company=None frac_class=None rig_class=None completion_class=None category=None modeled=None state_reported=None
INFO:Querying data for simulation. This may take a few minutes.
INFO:Defaults request successful
INFO:CreateSimulation initialized successfully.

  1. Retrieve Suggested Simulation Parameters

To retrieve the suggested values for simulation parameters based on query results, use the following code.

# Suggested values for simulation parameters based on query results
simulation.defaults

Output: The returned result will provide the recommended values for the simulation parameters.

 {'avg_fracs': 6,
'avg_gas': 5.83,
'avg_oil': 0.09,
'avg_well_frac_ratio': 3.4403873892048535,
'avg_wells': 24,
'gas_decl_def': -0.048086993134153336,
'gas_ipr_def': 11454,
'gas_min_def': 296,
'oil_decl_def': -0.08133736573120617,
'oil_ipr_def': 287,
'oil_min_def': 2}