Helper Functions

whitson_connect is a collection of API helper functions, packaged within a WhitsonConnection class.

Most of the examples in this manual use the whitson_connect library.

You can download the python file below and simply import it into your own script to execute some of the example workflows in subsequent sections. Using a WhitsonConnection object to run HTTP requests and access some of the endpoints available to you.

This simplifies the process of making external API requests in whitson⁺ to fetch data, create wells, add production data, adjust settings in bulk, run calculations in the software and finally also extract results and information from whitson⁺.

Helper Class: WhitsonConnection

What does this script, whitson_connect.py do?

This script defines a helper class WhitsonConnection, used for example to import production data from ARIES here.

Click here to download whitson_connect.py

Save the script in this section as a python file in your working directory and import whitson_connect in your script to call these functions using a WhitsonConnection object - you can pass arguments and data as parameters and payloads, respectively.

The class shows a few examples of the available endpoints. A complete list can be found here.

import http.client
import json
import requests
import os 
import time
import math
import random
import pandas as pd
import warnings
import numpy as np
from datetime import datetime
from sqlalchemy import create_engine
from snowflake.sqlalchemy import URL


class WhitsonConnection:
    def __init__(self, client_name, client_id, client_secret):
        self.client_name = client_name
        self.client_id = client_id
        self.client_secret = client_secret
        self.access_token = None

    def get_access_token(self):
        """
        Get a access token for a given work session.
        """
        conn = http.client.HTTPSConnection("whitson.eu.auth0.com")
        payload = {
            "client_id": self.client_id,
            "client_secret": self.client_secret,
            "audience": f"https://{self.client_name}.whitson.com/",
            "grant_type": "client_credentials",
        }

        headers = {"content-type": "application/json"}
        conn.request("POST", "/oauth/token", json.dumps(payload), headers)
        res = conn.getresponse()
        data = res.read()
        return json.loads(data.decode("utf-8")).get("access_token")

    def _read_token_from_file(self, file_path):
        if os.path.exists(file_path):
            with open(file_path, 'r') as file:
                try:
                    data = json.load(file)
                    return data.get('client_id'), data.get('access_token'), data.get('timestamp')
                except json.JSONDecodeError:
                    return None, None, None
        else:
            return None, None, None

    def _write_token_to_file(self, file_path, token, timestamp):
        data = {'client_id': self.client_id, 'access_token': token, 'timestamp': timestamp}
        with open(file_path, 'w') as file:
            json.dump(data, file)

    def get_access_token_smart(self):
        """
        Get an access token for a given work session. 
        Does not request a new one if the previous token has been requested within the last 24 hrs. 
        """
        token_file_path = "access_token.txt"
        stored_client_id, stored_token, stored_timestamp = self._read_token_from_file(token_file_path)

        current_time = time.time()

        # Check if a token was previously requested within the last 24 hours
        if stored_client_id == self.client_id and stored_token and (current_time - stored_timestamp) < (24 * 60 * 60):
            return stored_token
        else:
            conn = http.client.HTTPSConnection("whitson.eu.auth0.com")
            payload = {
                "client_id": self.client_id,
                "client_secret": self.client_secret,
                "audience": f"https://{self.client_name}.whitson.com/",
                "grant_type": "client_credentials",
            }

            headers = {"content-type": "application/json"}
            conn.request("POST", "/oauth/token", json.dumps(payload), headers)
            res = conn.getresponse()
            data = res.read()
            new_token = json.loads(data.decode("utf-8")).get("access_token")

            # Update the stored token and timestamp
            self._write_token_to_file(token_file_path, new_token, current_time)

            return new_token


    def get_valid_or_default(self, value: float, default: float = None) -> float:
        """
        Returns the given value if it is not NaN; otherwise, returns the specified default value.

        Args:
            value (float): The value to be checked for NaN.
            default (float, optional): The value to return if the input is NaN. Defaults to None.

        Returns:
            float: The original value if it is not NaN, otherwise the default value.
        """
        return value if not pd.isna(value) else default

    def get_well_id_by_uwi_api(self, wells : list[dict], uwi_api: str):
        """
        Get the well_id of a given uwi_api.

        lookup_key is the database value in whitson+ where the uwi_api is stored, typically uwi_api or external_id.

        """
        return next(
            (well["id"] for well in wells if well.get('uwi_api') == uwi_api),
            None  # Default value if no match is found
        )


    def get_well_id_by_propnum(self, wells : list[dict], propnum: str, lookup_key : str = "uwi_api"):
        """
        Get the well_id of a given propnum.

        lookup_key is the database value in whitson+ where the propnum is stored, typically uwi_api or external_id.

        """
        return next(
            (well["id"] for well in wells if well.get(lookup_key) == propnum),
            None  # Default value if no match is found
        )

    def get_well_id_by_wellname(self, wells : list[dict], wellname: str):
        """
        Get the well_id of a given wellname.
        """
        return next(
            (well["id"] for well in wells if well.get('name') == wellname),
            None  # Default value if no match is found
        )

    def get_fields(self):
        """
        Get all fields on domain.
        """
        base_url = f"https://{self.client_name}.whitson.com/api-external/v1/"
        response = requests.get(
            base_url + "fields",
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
        )
        res = response.json()
        if not res:
            raise Exception("no existing fields")
        return res

    def get_wells(self, project_id : int):
        """
        Get a list of wells in a project.
        """
        base_url = f"http://{self.client_name}.whitson.com/api-external/v1/wells"
        response = requests.get(
            base_url,
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
            params={
                "project_id": project_id,
            },
        )
        res = response.json()
        if not res:
            return []
        return res

    def get_well_from_well_id(self, well_id : int):
        """
        Get the well info, given a well ID.
        """
        base_url = f"http://{self.client_name}.whitson.com/api-external/v1/wells"
        response = requests.get(
            base_url,
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
            params={
                "well_id": well_id,
            },
        )
        res = response.json()
        if not res:
            return []
        return res

    def get_wells_from_projects(self, project_ids: list[int], page_size : int = 1000):
        """
        Get a list of wells from projects with project_id given in list.

        Example: whitson_wells = whitson_connection.get_wells_from_project([1, 2, 3])

        Lower the page size if 502 Error
        """
        all_wells = []
        base_url = f"http://{self.client_name}.whitson.com/api-external/v1/wells_paginated"

        for project_id in project_ids:
            page = 1  # Start with the first page

            while True:
                response = requests.get(
                    base_url,
                    headers={
                        "content-type": "application/json",
                        "Authorization": f"Bearer {self.access_token}",
                    },
                    params={
                        "project_id": project_id,
                        "page": page,
                        "page_size": page_size, # Lower this if Error 502
                    },
                )
                res = response.json()

                if not res:  # If the response is empty, there are no more wells for this project
                    break

                all_wells.extend(res)  # Append the wells from this page to the list of all wells
                page += 1  # Move to the next page

        return all_wells

    def get_wells_and_scenarios_from_projects(self, project_ids: list[int], page_size : int = 1000):
        """
        Get 2 lists - one for all wells, one for all scenarios (except those created by @whitson.com users) 
        - from multiple projects with each project_id given in list.

        Example payload:
        project_ids = [1,2,3]

        Example function call:
        whitson_wells = whitson_connection.get_wells_and_scenarios_from_projects(project_ids)

        Lower the page size if 502 Error
        """
        all_wells = []

        all_scenarios = []
        base_url = f"http://{self.client_name}.whitson.com/api-external/v1/wells_paginated"

        #print("Collecting Wells for Projects - ", project_ids)
        for project_id in project_ids:
            page = 1  # Start with the first page

            while True:
                response = requests.get(
                    base_url,
                    headers={
                        "content-type": "application/json",
                        "Authorization": f"Bearer {self.access_token}",
                    },
                    params={
                        "project_id": project_id,
                        "page": page,
                        "page_size": page_size, # Lower this if Error 502
                    },
                )
                res = response.json()

                if not res:  # If the response is empty, there are no more wells for this project
                    break
                #print("Writing page", page, " for project id -", project_id)
                all_wells.extend(res)  # Append the wells from this page to the list of all wells
                page += 1  # Move to the next page

            #print("Found - ", len(all_wells), "wells in total for all projects", project_ids)

            #Collecting Scenarios for Project
            #print("Collecting Scenarios for Project - ", project_id)
            base_url_scenario = f"http://{self.client_name}.whitson.com/api-external/v1/scenario"
            response = requests.get(
                        base_url_scenario,
                        headers={
                            "content-type": "application/json",
                            "Authorization": f"Bearer {self.access_token}",
                        },
                        params={
                            "project_id": project_id,
                            },
                    )

            res = response.json()

            #keeping only external scenarios
            external_scenarios = []
            #print("Found ", len(res), " scnenarios in project id - ", project_id)
            for i, scenario in enumerate(res.copy()):
                if "@whitson.com" not in scenario["owner"]:
                    scenario["project_id"] = project_id 
                    scenario["name"] = next((well["name"] for well in all_wells if well.get("id") == scenario["main_well_id"]), None) 
                    scenario["id"] = scenario["scenario_id"] #Consistent with get wells
                    external_scenarios.append(scenario)
            #print("Found ", len(external_scenarios)," external scenarios in project", project_id)
            all_scenarios.extend(external_scenarios) #keeping only external scenarios

        return all_wells, all_scenarios

    def get_projects(self, field_id: int):
        """
        Get a list of projects in field.
        """
        base_url = f"http://{self.client_name}.whitson.com/api-external/v1/fields/{field_id}/projects"
        response = requests.get(
            base_url,
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
        )
        res = response.json()
        if not res:
            raise Exception("no existing wells")
        return res

    def create_well(self, payload: dict) -> requests.Response:
        """
        Create a new well on a domain.
        """
        base_url = f"http://{self.client_name}.whitson.com/api-external/v1/wells"
        response = requests.post(
            base_url,
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
            json=payload,
        )
        if response.status_code >= 200 and response.status_code < 300:
            print(f"successfully created well {payload['name']}")
        else:
            print(response.text)
        return response

    def edit_well_info(self, payload: dict) -> requests.Response:
        """
        Edit well info for one or more wells at the same time. 

        Example payload:
        well_info = [{'id': 10, 'l_w': 5000}, {'id': 11, 'l_w': 10000}]

        Example function call:
        whitson_connection.edit_well_info(well_info)

        More info about endpoint here: https://internal.whitson.com/api-external/swagger/#/Base%20Data/patch_api_external_v1_wells
        """
        base_url = f"http://{self.client_name}.whitson.com/api-external/v1/wells"
        response = requests.patch(
            base_url,
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },  
            json=payload,
        )
        if response.status_code >= 200 and response.status_code < 300:
            print(f"successfully edited well(s).")
        else:
            print(response.text)
        return response

    def create_project(self, field_id: int, payload: dict) -> requests.Response:
        """
        Create a new project on a domain.
        """
        base_url = f"http://{self.client_name}.whitson.com/api-external/v1/fields/{field_id}/projects"
        response = requests.post(
            base_url,
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
            json=payload,
        )
        if response.status_code >= 200 and response.status_code < 300:
            print(f"successfully created project {payload['name']}")
        else:
            print(response.text)
        return response

    def upload_production_to_well(
        self,
        well_id: int,
        payload: list[dict],
        append_only: bool = False,
    ) -> requests.Response:
        """
        Upload production data to well.

        Parameters:
        well_id (int): The ID of the well to update.
        payload (list[dict]): A list of dictionaries containing the production data.
        append_only (bool): Determines the behavior for handling existing data.
            - False: Replaces existing data for matching dates with payload data. For a given matching date, the entire dataset will be replaced with the payload data (not merged). Appends new data if the date does not exist. Does not affect old data not in the payload.
            - True: Appends new data if the date does not exist. Rejects payload data if the date exists. Does not affect old data not in the payload.

        Returns:
        requests.Response: The response from the API after attempting to upload the production data.
        """
        response = requests.post(
            f"http://{self.client_name}.whitson.com/api-external/v1/wells/{well_id}/production_data",
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
            json=payload,
            params={"append_only": append_only},
        )
        if response.status_code >= 200 and response.status_code < 300:
            print(f"successfully updated production data on well {well_id}")
        else:
            print(response.text)
        return response

    def bulk_upload_production_to_well(self, payload: list[dict]) -> requests.Response:
        """
        Uploads production data to a specified well in bulk.

        This function sends a POST request to the Whitson API to upload a list of production data records associated with a well. 
        Each production data entry must include the `well_id` and the `date` of the production.

        Parameters:
        - payload (list[dict]): A list of dictionaries containing production data entries. 
        Each dictionary should have the following keys:
            - well_id (int): The ID of the well that holds the production record. (required)
            - date (str): The date of the production in ISO 8601 format (e.g., "2024-09-14T21:07:08.556Z"). (required)
            - Additional optional fields may include:
            - qo_sc, qw_sc, qg_sc, qo_se, qw_se, qg_se, qo_sep, qw_sep, qg_sep, p_sep, t_sep, p_wf_measured, 
                p_tubing, p_casing, p_gas_lift, liquid_level, choke_size, line_pressure, etc., as defined by the API.

        Returns:
        - requests.Response: The response object from the POST request.
        - If the request is successful (status code 200-299), "success" is printed.
        - If the request fails, the error response text is printed.

        Example:
        >>> payload = [
                {
                    "well_id": 123,
                    "date": "2024-09-14T21:07:08.556Z",
                    "qo_sc": 100.0,
                    "qw_sc": 200.0,
                    # Additional production data fields...
                }
            ]
        >>> response = bulk_upload_production_to_well(payload)
        >>> if response.status_code == 200:
                print("Production data uploaded successfully.")
            else:
                print("Failed to upload production data.")
        """
        response = requests.post(
            f"http://{self.client_name}.whitson.com/api-external/v1/wells/production_data",
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
            json=payload,
        )
        if response.status_code >= 200 and response.status_code < 300:
            print("success")
        else:
            print(response.text)
        return response

    def convert_dataframe_to_prod_payload(self, df, columns_to_drop: list[str]) -> list[dict]:
        """
        Converts a DataFrame into a production data payload suitable for the Whitson+ API.

        This function processes a DataFrame by dropping specified columns, removing rows where the well ID is not found,
        and converting any NaN values to None to ensure JSON compatibility. The 'date' column is formatted to ISO 8601 format.

        **Assumptions:**
        - The DataFrame is expected to contain the columns as shown in the provided schema, including:
        'well_id', 'date', 'qo_sc', 'qg_sc', 'qw_sc', 'qo_sep', 'qg_sep', 'qw_sep', 'p_sep', 't_sep',
        'p_wf_measured', 'p_tubing', 'p_casing', 'qg_gas_lift', 'liquid_level', 'choke_size', 'line_pressure'.
        - The 'date' column must be present and contain date values that can be converted to ISO 8601 format.
        - The DataFrame is assumed to be in the format shown in the provided image, where certain values may be NaN.

        Parameters:
        - df (pd.DataFrame): The input DataFrame containing production data.
        - columns_to_drop (list[str]): A list of column names to be dropped from the DataFrame.

        Returns:
        - list[dict]: A list of dictionaries where each dictionary represents a row of the production data payload 
        formatted for the Whitson+ API.

        Example:
        >>> payload = convert_dataframe_to_prod_payload(df, ['insert_date'])
        >>> print(payload)
        [
            {
                "well_id": 0,
                "date": "2024-09-14T21:07:08.556Z",
                "qo_sc": None,
                "qg_sc": None,
                "qw_sc": None,
                "qo_sep": None,
                "qg_sep": None,
                "qw_sep": None,
                "p_sep": None,
                "t_sep": None,
                "p_wf_measured": None,
                "p_tubing": None,
                "p_casing": None,
                "qg_gas_lift": None,
                "liquid_level": None,
                "choke_size": None,
                "line_pressure": None
            }
        ]
        """
        # Drop the specified columns from the DataFrame
        df = df.drop(columns=columns_to_drop)

        # Record the original number of rows
        original_row_count = len(df)

        # Drop rows where 'well_id' is NaN after mapping
        df = df.dropna(subset=['well_id'])

        # Record the new number of rows
        new_row_count = len(df)

        # Print a message if rows were removed
        if original_row_count > new_row_count:
            print(f"Removed {original_row_count - new_row_count} rows where UWI was not found in the dictionary.")

        # Replace NaN values with None for JSON compatibility
        df = df.replace({np.nan: None})

        # Convert the 'date' column to ISO 8601 format
        df['date'] = pd.to_datetime(df['date']).dt.strftime('%Y-%m-%dT%H:%M:%S.%fZ')

        # Convert the DataFrame to a list of dictionaries for API upload
        return df.to_dict('records')

    def get_production(
        self,
        well_id: int,
    ) -> requests.Response:
        """
        Get a list of wells.
        """
        response = requests.get(
            f"http://{self.client_name}.whitson.com/api-external/v1/wells/{well_id}/production_data",
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
        )
        res = response.json()
        if not res:
            raise Exception("no existing wells")
        return res

    def delete_prod_data(self, well_id: int | None = None):
        """
        Delete production to well.
        """
        base_url = f"http://{self.client_name}.whitson.com/api-external/v1/wells/{well_id}/production_data"
        response = requests.delete(
            base_url,
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
        )
        if response.status_code >= 200 and response.status_code < 300:
            print(f"successfully deleted production data for well {well_id}")
        else:
            print(response.text)
        return response

    def get_well_deviation_data(self, well_id: int) -> requests.Response:
        """
        Get well deviation data of a well in the database.
        """
        base_url = f"http://{self.client_name}.whitson.com/api-external/v1/wells/{well_id}/bhp_input/well_deviation_survey"
        response = requests.get(
            base_url,
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
        )
        res = response.json()
        if not res:
            raise Exception("Something went weong")
        return res


    def get_max_md_well_deviation_data(self, well_id: int) -> requests.Response:
        """
        Get the max md of a well deviation survey.
        """
        base_url = f"http://{self.client_name}.whitson.com/api-external/v1/wells/{well_id}/bhp_input/well_deviation_survey"
        response = requests.get(
            base_url,
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
        )
        res = response.json()

        if not res:
            raise Exception("Something went weong")
        else:
            if not res or not all('md' in item for item in res):
                return None
            else: 
                return max(item['md'] for item in res)

# ---------------------------------------------------------------------------------------------------------
# PVT Related Functions
# ---------------------------------------------------------------------------------------------------------

    def edit_input_quick(self, well_id: int, payload: dict) -> requests.Response:
        """
        Edit the input quick (PVT) property of a well.
        """
        response = requests.put(
            f"http://{self.client_name}.whitson.com/api-external/v1/wells/{well_id}/input_quick",
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
            json=payload,
        )
        if response.status_code >= 200 and response.status_code < 300:
            print(f"successfully edited input quick for well {well_id}")
        else:
            print(response.text)
        return response

### Getting mass fluid data

    def get_pvt_fluid_data(self, well_id:int) -> requests.Response:
        """
        Get the fluid properties after PVT initialization for {well_id}.

        Example payload:
        well_id = this_well_id (a number of type int)
        --> see swagger doc for additional params you can use such as well name or well id directly.

        Example usage:
        response = whitson_connection.get_pvt_fluid_data(well_id)

        """
        response = requests.get(
                f"http://{self.client_name}.whitson.com/api-external/v1/mass_fluid_data",
                headers={
                    "content-type": "application/json",
                    "Authorization": f"Bearer {self.access_token}",
                }, 
            params = {"well_id" : well_id}
            )

        if response.status_code == 200:
           print(f"Fluid data successfully retrieved for well_id {well_id} ")
        else:
            print("Something went wrong - ", response)

        return response.json()    


    def get_pvt_mass_fluid_data(self, project_id:int) -> requests.Response:
        """
        Get the fluid properties after PVT initialization for all the wells in {project_id}.

        Example payload:
        project_id = this_project_id (a number of type int)
        --> see swagger doc for additional params you can use such as well name or well id directly.

        Example usage:
        response = whitson_connection.get_pvt_mass_fluid_data(project_id)

        """
        response = requests.get(
                f"http://{self.client_name}.whitson.com/api-external/v1/mass_fluid_data",
                headers={
                    "content-type": "application/json",
                    "Authorization": f"Bearer {self.access_token}",
                }, 
            params = {"project_id" : project_id}
            )

        if response.status_code == 200:
           print(f"Fluid data successfully retrieved for all wells in project {project_id} ")
        else:
            print("Something went wrong - ", response)

        return response.json()    

    ### Getting bot table

    def get_pvt_bot_table(self, well_id) -> requests.Response:
        """
        Get the black oil table generated for the {well_id} - each row of the BOT is returned as one element in the response.

        Example payload:
        well_id = this_well_id

        Example usage:
        response = whitson_connection.get_pvt_bot_table(well_id)

        """
        response = requests.get(
                f"http://{self.client_name}.whitson.com/api-external/v1/wells/{well_id}/bot/bot_table",
                headers={
                    "content-type": "application/json",
                    "Authorization": f"Bearer {self.access_token}",
                }, 
            params = {"well_id" : well_id }
            )

        if response.status_code == 200:
            print(f"BOT successfully retrieved for well {well_id}")
        else:
            print("Something went wrong - ", response)

        return response.json()

    def run_composition_calc(self, well_id: int) -> requests.Response:
        """
        Run PVT (composition) calculation on well.
        """
        response = requests.get(
            f"http://{self.client_name}.whitson.com/api-external/v1/wells/{well_id}/run_composition_calc",
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
        )
        if response.status_code >= 200 and response.status_code < 300:
            print(f"success on running composition calc on well {well_id}")
        else:
            print(response.text)
        return response


    def calc_median_gor(self, well_id: int, production_data: list[dict] = None, is_sep_rates: bool = False, num_of_timesteps: int = 30, default: float = 1000) -> float: 
        """
        Calculate the median Gas-Oil Ratio (GOR) for a given well over a specified number of timesteps.

        This function retrieves production data for the specified well and calculates the GOR
        as the ratio of gas production (qg_sep) to oil production (qo_sep) for each timestep.
        If separator rates are used, the corresponding GOR is calculated using separator data.

        The function filters out None values and identifies the first valid non-zero GOR value. 
        It then calculates the median GOR from the subsequent data points, up to the specified 
        `number_of_timesteps`. If no valid GOR values are found, the function returns a default value.

        Parameters:
            well_id (int): The unique identifier for the well.
            production_data (dict, optional): use production data available instead of getting it from whitson+.
            is_sep_rates (bool, optional): Flag to determine if separator rates should be used. Defaults to False.
            num_of_timesteps (int, optional): The number of data points to consider for the median calculation. Defaults to 30.
            default (float, optional): The value to return if no valid GOR values are found. Defaults to 1000.

        Returns:
            float: The median GOR value for the specified well over the selected time steps, 
                or the default value if no valid data is available.
        """
        production_data = self.get_production(well_id) if production_data == None else production_data

        prefix = '_sep' if is_sep_rates else ''
        qo_sep_series = [entry['qo' + prefix] for entry in production_data]
        qg_sep_series = [entry['qg' + prefix] for entry in production_data]
        gor = [qg / qo * 1000 if qo != 0 else None for qo, qg in zip(qo_sep_series, qg_sep_series)]

        filtered_gor = [value for value in gor if value is not None]
        first_non_zero_index = next((i for i, value in enumerate(filtered_gor) if value != 0), None)

        if first_non_zero_index is not None:
            selected_gor = filtered_gor[first_non_zero_index:first_non_zero_index + num_of_timesteps]

            return np.median(selected_gor) if selected_gor else None
        else:
            return default 

# ---------------------------------------------------------------------------------------------------------
# BHP Input Related Functions
# ---------------------------------------------------------------------------------------------------------


    def upload_well_data_to_well(
        self, well_id: int, payload: list[dict]
    ) -> requests.Response:
        """
        Upload a well data to a well.
        """
        base_url = f"http://{self.client_name}.whitson.com/api-external/v1/wells/{well_id}/bhp_input/well_data"
        response = requests.post(
            base_url,
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
            json=payload,
        )
        if response.status_code >= 200 and response.status_code < 300:
            print(f"successfully updated well_data to well {well_id}")
        else:
            print(response.text)
        return response

    def edit_well_data_for_well_data_id(
            self, well_data_id: int, payload: list[dict]
        ) -> requests.Response:
            """
            Edit a well data to for well_data_id WELL_DATA_ID.
            """
            base_url = f"http://{self.client_name}.whitson.com/api-external/v1/wells/bhp_input/well_data/{well_data_id}"
            response = requests.put(
                base_url,
                headers={
                    "content-type": "application/json",
                    "Authorization": f"Bearer {self.access_token}",
                },
                json=payload,
            )
            if response.status_code >= 200 and response.status_code < 300:
                print(f"successfully updated well_data to well {well_data_id}")
            else:
                print(response.text)
            return response


    def edit_well_deviation_data(
        self, well_id: int, payload: list[dict]
    ) -> requests.Response:
        """
        Edit well deviation data of a well in the database.
        """
        base_url = f"http://{self.client_name}.whitson.com/api-external/v1/wells/{well_id}/bhp_input/well_deviation_survey"
        response = requests.put(
            base_url,
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
            json=payload,
        )
        if response.status_code >= 200 and response.status_code < 300:
            print(f"changed well deivation survey on well_id {well_id}")
        else:
            print(response.text)
        return response

    def run_bhp_calc(self, well_id: int) -> requests.Response:
        """
        Run bhp calculation on the well specified by the provided well_id.

        More info here: https://internal.whitson.com/api-external/swagger/#/BHP%20Data/get_api_external_v1_wells_run_bhp_calculation
        """
        base_url = f"http://{self.client_name}.whitson.com/api-external/v1/wells/{well_id}/run_bhp_calculation"
        response = requests.get(
            base_url,
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
        )
        if response.status_code == 202:
            print(f"successfully ran bhp calc on Well: {well_id}")
        else:
            print(response.text)

    def run_bhp_calc_in_projects(self, project_ids: list) -> requests.Response:
        """
        Bulk Run bhp calculation on all the wells specified by the provided project_ids

        Example Payload:
        project_ids = [255, 94]
        Example function call:
        whitson_connection.run_bhp_calc_in_projects(project_ids)

        More info here: https://internal.whitson.com/api-external/swagger/#/BHP%20Data/get_api_external_v1_wells_run_bhp_calculation
        """
        base_url = f"http://{self.client_name}.whitson.com/api-external/v1/wells/run_bhp_calculation"

        for project_id in project_ids:
            response = requests.get(
                base_url,
                headers={
                    "content-type": "application/json",
                    "Authorization": f"Bearer {self.access_token}",
                },
                params = {"project_id" : project_id}
            )
            if response.status_code == 202:
                print(f"successfully ran bhp calc on Project: {project_id}")
            else:
                print(response.text)

    def run_separator_oil_shrinkage_calc(self, well_id: int) -> requests.Response:
        """
        Run common process conversion and separator oil shrinkage on the well specified by the provided well_id.

        More info here: https://internal.whitson.com/api-external/swagger/#/Well%20Monitoring/get_api_external_v1_wells__well_id__run_well_monitoring
        """
        base_url = f"http://{self.client_name}.whitson.com/api-external/v1/wells/{well_id}/run_well_monitoring"
        response = requests.get(
            base_url,
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
        )
        if response.status_code == 202:
            print(f"successfully run separator oil shrinkage calc on {well_id}")
        else:
            print(response.text)
        return response

    def get_bhp_calc(self, well_id: int, from_date: str = None) -> requests.Response:
        """
        Get bhp calculation on the well specified by the provided well_id. 
        If from_date is specified as "YYYY-MM-DD" the BHP calcs after this date is returned. 
        If the from_date is not specified, all BHP records are returned.

        More info here: https://internal.whitson.com/api-external/swagger/#/BHP%20Data/get_api_external_v1_wells__well_id__bhp_calculation
        """
        base_url = f"http://{self.client_name}.whitson.com/api-external/v1/wells/{well_id}/bhp_calculation"
        response = requests.get(
            base_url,
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
            params = {
                "from_date": from_date
            },
        )
        if response.status_code == 200:
            print(f"successfully retrieved bhp calc on {well_id}")
        else:
            print(response.text)
        return response.json()

    def get_bhp_from_projects(self, project_ids: list[int], from_date: str = None, page_size : int = 1000) -> requests.Response:
        """
        Get a list of well BHPs from projects with project_id given in list.
        Example: whitson_wells_bhp = whitson_connection.get_bhp_from_projects([1, 2, 3])
        If from_date is specified as "YYYY-MM-DD" the BHP calcs after this date is returned. 
        If the from_date is not specified, all BHP records are returned.
        Lower the page size if 502 Error
        """
        all_wells = []
        base_url = f"http://{self.client_name}.whitson.com/api-external/v1/wells/bhp_calculation"
        for project_id in project_ids:
            page = 1  # Start with the first page
            while True:
                response = requests.get(
                    base_url,
                    headers={
                        "content-type": "application/json",
                        "Authorization": f"Bearer {self.access_token}",
                    },
                    params={
                        "project_id": project_id,
                        "page": page,
                        "from_date": from_date,
                        "page_size": page_size, # Lower this if Error 502
                    },
                )
                res = response.json()
                if not res:  # If the response is empty, there are no more wells for this project
                    break
                all_wells.extend(res)  # Append the wells from this page to the list of all wells
                page += 1  # Move to the next page
        return all_wells

    def get_well_data(self, well_id: int = 0):
        """
        Get the wellbore info.
        """
        base_url = f"http://{self.client_name}.whitson.com/api-external/v1/wells/{well_id}/bhp_input/well_data"
        response = requests.get(
            base_url,
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
        )
        return response.json()

    def get_well_deviation_and_perf_interval(self, well_id: int = 0):
        """
        Get the bottomhole pressure input.
        """
        base_url = f"http://{self.client_name}.whitson.com/api-external/v1/wells/{well_id}/bhp_input"
        response = requests.get(
            base_url,
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
        )
        return response.json()


    def edit_perf_interval(self, well_id: int, payload: list[dict]):
        """
        Edit perf interval
        """
        base_url = f"http://{self.client_name}.whitson.com/api-external/v1/wells/{well_id}/bhp_input"
        response = requests.put(
            base_url,
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
            json=payload,
        )
        if response.status_code >= 200 and response.status_code < 300:
            print(f"changed well deivation survey on well_id {well_id}")
        else:
            print(response.text)
        return response

    def is_wellbore_configuration_already_uploaded(self, new_wellbore_configuration, existing_wellbore_data):
        """
        Checks if a wellbore configuration with the same 'use_from_date' as the new configuration
        already exists in the existing wellbore data.

        Args:
            new_wellbore_configuration (dict): The new wellbore configuration to check.
            existing_wellbore_data (list of dict): The list of existing wellbore configurations.

        Returns:
            bool: True if a configuration with the same 'use_from_date' already exists, False otherwise.
        """
        return any(wellbore['use_from_date'] == new_wellbore_configuration['use_from_date'] for wellbore in existing_wellbore_data)

    def is_default_well_configuration(self, wellbore_data) -> bool:
        """
        Checks if the provided wellbore data represents a default well configuration.

        Args:
            wellbore_data (list of dict): List containing dictionaries representing wellbore data.
                Each dictionary should have keys 'use_from_date', 'well_data_casing', and 'well_data_tubing'.

        Returns:
            bool: True if the well configuration matches default criteria:
                - 'bottom_md' of the first casing is 12000,
                - 'bottom_md' of the first tubing is 7000,
                - 'use_from_date' is None.
            False otherwise.
        """
        if not isinstance(wellbore_data, list) or len(wellbore_data) == 0:
            return False

        first_well_data = wellbore_data[0]

        return (
            first_well_data.get('use_from_date') is None
            and first_well_data.get('well_data_casing', [{}])[0].get('bottom_md') == 12000
            and first_well_data.get('well_data_tubing', [{}])[0].get('bottom_md') == 7000
        )

    def is_default_deviation_survey(self, well_id: int) -> bool:
        """
        Checks if the provided deviation survey is is whitson+ default.
        """

        default_survey = [{'md': 0.0, 'tvd': 0.0}, {'md': 7000.0, 'tvd': 7000.0}, {'md': 12000.0, 'tvd': 7000.0}]
        return (default_survey ==  self.get_well_deviation_data(well_id))


    def is_default_perforated_interval(self, well_id) -> bool:
        """
        Checks if the provided perforation interval is whitson+ default.
        """

        well_and_perf = self.get_well_deviation_and_perf_interval(well_id)

        return (
            well_and_perf.get('top_perforation_md') == 7100
            and well_and_perf.get('bottom_perforation_md') == 12000
        )

    def run_numerical_model(self, well_id: int):
        """
        Run numerical model
        """
        base_url = f"http://{self.client_name}.whitson.com//api-external/v1/wells/{well_id}/run_history_matching"
        response = requests.get(
            base_url,
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
            params={"well_id": str(well_id), "grid_refinement": "Low", "rate_control": "BHP", "include_forecast": "true"},
        )
        if response.status_code >= 200 and response.status_code < 300:
            print(f"Successfully ran numerical model for well with id {well_id}")
        else:
            print(response.text)
        return response

    def get_numerical_model_rates_and_pressures(self, well_id: int):
        """
        Edit perf interval
        """
        base_url = f"http://{self.client_name}.whitson.com//api-external/v1/wells/{well_id}/history_matching"
        response = requests.get(
            base_url,
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
        )
        if response.status_code >= 200 and response.status_code < 300:
            print(f"successfully retrieved numerical model rates and pressures for well_id {well_id}")
        else:
            print(response.text)
        return response.json()

    def get_pwf_active(self, well_id: int, from_date: str = None) -> requests.Response:
        """s
        Get active pwf from the database for the given well_id, from the start date in from_date.

        Example params:
        this_well_id = integer
        this_from_date = "YYYY-MM-DD"

        Example function call:
        active_pwf_well = whitson_connection.get_pwf_active(this_well_id, this_from_date)
        """

        base_url = f"http://{self.client_name}.whitson.com/api-external/v1/wells/{well_id}/pwf_active"
        response = requests.get(
            base_url,
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
            params={"from_date": from_date},
        )
        if response.status_code == 200:
            print(f"successfully received active pwf on {well_id}")
        else:
            print(response.text)
        return response.json()

    def get_pwf_active_multiple(self, payload: dict) -> requests.Response:
        """
        Get active pwf from the database for all the well_ids from the start date in from_date

        Example payload:
        payload = {"from_date":"YYYY-MM-DD", "page": 0, "page_size": 10}

        Example function call:
        active_pwf_wells = whitson_connection.get_pwf_active_multiple(payload)

        """

        base_url = f"http://{self.client_name}.whitson.com/api-external/v1/wells/pwf_active"
        response = requests.get(
            base_url,
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
            params=payload,
        )
        if response.status_code == 200:
            print(f"successfully recieved active pwf")
        elif response.status_code == 404:
            print(f"No wells found matching the payload criteria") 
        else: print(response.text)
        return response.json()

    def get_available_custom_attributes(self, well_id: int) -> requests.Response:
        """
        Get available (existing) custom attributes for well {well_id}.

        Example params:
        this_well_id = integer

        Example function call:
        response = whitson_connection.get_available_custom_attributes(this_well_id)
        """
        response = requests.get(
            f"http://{self.client_name}.whitson.com/api-external/v1/wells/{well_id}/available_custom_attributes",
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            }
        )

        if response.status_code == 200:
            print(f"Custom attribute(s) successfully retrieved for well {well_id}")
        else:
            print("Something went wrong - ", response)

        return response.json()

    def get_custom_attribute_value(self, well_id: int) -> requests.Response:
        """
        Get values for (existing) custom attributes for well {well_id}.

        Example params:
        this_well_id = integer

        Example function call:
        response = whitson_connection.get_custom_attributes_value(this_well_id)
        """
        response = requests.get(
            f"http://{self.client_name}.whitson.com/api-external/v1/wells/{well_id}/custom_attributes",
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            }
        )

        if response.status_code == 200:
            print(f"Custom attribute(s) data successfully retrieved for well {well_id}")
        else:
            print("Something went wrong - ", response)

        return response.json()

    def delete_custom_attribute_value(self, well_id: int, attribute_name: str) -> requests.Response:
        """
        Delete values for (existing) custom attributes for well {well_id}. Note that this does not delete the custom attribute from the project.

        Example params:
        this_well_id = integer
        this_custom_attribute = 'MyAttribute'

        Example function call:
        response = whitson_connection.delete_custom_attributes_value(this_well_id, this_custom_attribute)
        """
        response = requests.delete(
            f"http://{self.client_name}.whitson.com/api-external/v1/wells/{well_id}/custom_attributes/{attribute_name}",
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            }
        )

        if response.status_code == 200:
            print(f"Custom attribute(s) successfully updated for well {well_id}")
        else:
            print("Something went wrong - ", response)

        return response.json()

    def edit_custom_attribute_value(self, well_id: int, payload: dict) -> requests.Response:
        """
        Set values for (existing) custom attributes for well {well_id}.

        Example payload:
        payload = {"attribute_name": "MyNumericAttribute",
           "number_attribute": {"attribute_value": 1250}}

        Example function call:
        response = whitson_connection.set_custom_attributes_value(this_well_id, payload)
        """
        response = requests.post(
            f"http://{self.client_name}.whitson.com/api-external/v1/wells/{well_id}/custom_attributes",
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
            json = payload,
        )

        if response.status_code == 200:
            print(f"Custom attribute(s) successfully updated for well {well_id}")
        elif response.status_code == 403:
            print(f"Custom attribute does not exist")
        else:
            print("Something went wrong - ", response)

        return response

    def edit_well_deviation_survey(self, well_id: int, payload: dict) -> requests.Response:
        """

        Example payload: [{'md': 0, 'tvd': 0}, {'md': 95.1, 'tvd': 95.1}, {'md': 153.6, 'tvd': 153.6}]

        Endpoint: https://internal.whitson.com/api-external/swagger/#/BHP%20Data/put_api_external_v1_wells__well_id__bhp_input_well_deviation_survey

        """
        response = requests.put(
            f"http://{self.client_name}.whitson.com/api-external/v1/wells/{well_id}/bhp_input/well_deviation_survey",
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
            json=payload,
        )
        if response.status_code >= 200 and response.status_code < 300:
            print(f"successfully edited well deviation survey for {well_id}.")
        else:
            print(response.text)
        return response

    def delete_wellbore_config_by_well_data_id(self, well_data_id: int): 
        """
        Delete wellbore with wellbore id well_data_id.
        """
        response = requests.delete(
            f"http://{self.client_name}.whitson.com/api-external/v1/wells/bhp_input/well_data/{well_data_id}",
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            }
        )

        if response.status_code == 200:
            print(f"Wellbore config {well_data_id} successfully deleted")
        else:
            print("Something went wrong - ", response)

        return response.json()

# ---------------------------------------------------------------------------------------------------------
# Analytical RTA Related Functions
# ---------------------------------------------------------------------------------------------------------

    def get_classical_rta_interpretation(self, well_id: int) -> requests.Response:
        """
        Get (existing) classical RTA results for well {well_id}.

        Example params:
        this_well_id = integer

        Example function call:
        response = whitson_connection.get_classical_rta_interpretation(this_well_id)
        """
        response = requests.get(
            f"http://{self.client_name}.whitson.com/api-external/v1/wells/{well_id}/arta_interpretations",
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            }
        )

        if response.status_code == 200:
            print(f"Classical RTA data successfully retrieved for well {well_id}")
            return response.json()
        else:
            print("Something went wrong - ", response)

    def get_analytical_rta_timeseries(self, well_id: int) -> requests.Response:
        """
        Get (existing) analytical RTA timeseries for well {well_id}.

        Example params:
        this_well_id = integer

        Example function call:
        response = whitson_connection.get_analytical_rta_time_series(this_well_id)
        """
        response = requests.get(
            f"http://{self.client_name}.whitson.com/api-external/v1/wells/{well_id}/arta_time_series",
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            }
        )

        if response.status_code == 200:
            print(f"Analytical RTA timeseries data successfully retrieved for well {well_id}")
        else:
            print("Something went wrong - ", response)

        return response.json()


    def get_material_balance_timeseries(self, well_id: int) -> requests.Response:
        """
        Get (existing) material balance timeseries for well {well_id}.

        Example params:
        this_well_id = integer

        Example function call:
        response = whitson_connection.get_material_balance_timeseries(this_well_id)
        """
        response = requests.get(
            f"http://{self.client_name}.whitson.com/api-external/v1/wells/{well_id}/material_balance_time",
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            }
        )

        if response.status_code == 200:
            print(f"Material balance timeseries successfully retrieved for well {well_id}")
        else:
            print("Something went wrong - ", response)

        return response.json()

    def get_fractional_rta_interpretations(self, well_id: int) -> requests.Response:
        """
        Get (existing) fractional RTA interpretations for well {well_id}.

        Example params:
        this_well_id = integer

        Example function call:
        response = whitson_connection.get_fractional_rta_interpretations(this_well_id)
        """
        response = requests.get(
            f"http://{self.client_name}.whitson.com/api-external/v1/wells/{well_id}/fractional_rta_interpretations",
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            }
        )

        if response.status_code == 200:
            print(f"Fractional RTA data successfully retrieved for well {well_id}")
        else:
            print("Something went wrong - ", response)

        return response.json()


# ---------------------------------------------------------------------------------------------------------
# Numerical RTA Related Functions
# ---------------------------------------------------------------------------------------------------------

    def _get_nrta_report_dataframe(self):
        return pd.DataFrame(
            columns=[
                "Run",
                "swi",
                "fcd",
                "swc",
                "sorw",
                "sorg",
                "sgc",
                "nw",
                "now",
                "ng",
                "nog",
                "Error",
                "Probability_to_Accept",
                "Was_Accepted",
            ]
        )


    def _edit_nrta_weight_factors(self, payload: dict) -> requests.Response:
        """
        Edit numerical RTA weight factors.

        payload = [{
            "well_id": 1,
            "oil_cum": 0,
            "gas_cum": 0,
            "water_cum": 0,
            "gor_cum": 0,
            "oil": 0,
            "gas": 0,
            "water": 0,
            "gor": 0
        }]
        """
        response = requests.put(
        f"http://{self.client_name}.whitson.com/api-external/v1/wells/edit_nrta_weight_factors",
        headers={
            "content-type": "application/json",
            "Authorization": f"Bearer {self.access_token}",
        },
        json=payload,
        )
        return response

    def _edit_nrta_project_parameters(self, project_id: int, params):
        swi, fcd, swc, sorw, sorg, sgc, nw, now, ng, nog = params
        rel_perm_fcd = {
            "fcd": fcd,
            "swc": swc,
            "sorw": sorw,
            "sorg": sorg,
            "sgc": sgc,
            "nw": nw,
            "now": now,
            "ng": ng,
            "nog": nog,
            "krwro": 1,
            "krgro": 1,
            "krocw": 1,
            "fracture_swc": 0,
            "fracture_sorw": 0,
            "fracture_sorg": 0,
            "fracture_sgc": 0,
            "fracture_nw": 1,
            "fracture_now": 1,
            "fracture_ng": 1,
            "fracture_nog": 1,
            "fracture_krwro": 1,
            "fracture_krocw": 1,
            "fracture_krgro": 1,
        }

        swi_gamma_cr = {
            "Sw_i": swi,
            "gamma_m": 0.0000,
            "gamma_f": 0.0000,
            "cr": 0.000004,
        }

        wells = self.get_wells(project_id)

        rel_perm_fcd_payload = []
        swi_pressure_dep_payload = []

        for well in wells:
            well_id = well["id"]

            # For rel_perm_fcd_payload
            rel_perm_fcd_payload.append(
                {"well_id": well_id, **rel_perm_fcd}  # Unpack rel_perm_fcd dictionary
            )

            # For swi_pressure_dep_payload
            swi_pressure_dep_payload.append(
                {"id": well_id, **swi_gamma_cr}  # Unpack swi_gamma_cr dictionary
            )

        self.__edit_input_nrta_rel_perm_and_fcd_all_wells_project(rel_perm_fcd_payload)
        self.__edit_swi_pressure_dep_all_wells_in_project(swi_pressure_dep_payload)

    def __edit_swi_pressure_dep_all_wells_in_project(self, payload: dict) -> requests.Response:
        """
        Edit the NRTA input for all wells in project.
        """
        response = requests.patch(
            f"http://{self.client_name}.whitson.com/api-external/v1/wells",
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
            json=payload,
        )
        # if response.status_code >= 200 and response.status_code < 300:
        #     print(f"successfully edited info for well {well_id}")
        # else:
        # print(response.text)
        return response

    def __edit_input_nrta_rel_perm_and_fcd_all_wells_project(self, payload: dict) -> requests.Response:
        """
        Edit the NRTA input for all wells in project.
        """
        response = requests.put(
            f"http://{self.client_name}.whitson.com/api-external/v1/wells/rta_input",
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
            json=payload,
            # params={"project_id": self.project_id},
        )
        # if response.status_code >= 200 and response.status_code < 300:
        #     print(f"successfully edited input quick for well {well_id}")
        # else:
        #     print(response.text)
        return response

    def _run_nrta_on_all_wells_in_project(self, project_id : int, params : dict = {"grid_refinement": "Low", "num_type_curves": "5_normal"}, sleep_time : dict = 0):
        """
        Executes numerical rate transient analysis (NRTA) on all wells in the current project.

        This method iterates through all wells in the project and performs NRTA on each well
        using the specified parameters.

        Parameters:
        ----------
        params : dict, optional
        A dictionary containing parameters for the NRTA. Defaults to:
        {
            "grid_refinement": "Low",
            "num_type_curves": "5_normal"
        }
        - "grid_refinement" (str): Specifies the level of grid refinement for the NRTA. Possible values are "Low", "Medium", and "High".
        - "num_type_curves" (str): Specifies the number and type of curves to be used in the analysis. The default value is "5_normal".

        sleep_time : int, optional
        The amount of time to wait (in seconds) between processing each well. Defaults to 0.
        """

        wells = self.get_wells(project_id)
        for well in wells:
            time.sleep(sleep_time)
            well_id = well["id"]
            self.run_numerical_rta_for_well(well_id, params)


    def run_numerical_rta_for_well(self, well_id: int, params : dict = {"grid_refinement": "Low", "num_type_curves": "5_normal"}) -> requests.Response:
        """
        Runs numerical rate transient analysis (NRTA) for a specified well.

        This method sends a request to the Whitson API to initiate NRTA for the well identified by `well_id`
        using the given parameters.

        Parameters:
        ----------
        well_id : int
            The ID of the well for which to run the NRTA.
        params : dict, optional
            A dictionary containing parameters for the NRTA. Defaults to:
            {
                "grid_refinement": "Low",
                "num_type_curves": "5_normal"
            }
            - "grid_refinement" (str): Specifies the level of grid refinement for the NRTA. Possible values are "Low", "Medium", and "High".
            - "num_type_curves" (str): Specifies the number and type of curves to be used in the analysis. The default value is "5_normal".

        """

        response = requests.get(
            f"http://{self.client_name}.whitson.com//api-external/v1/wells/{well_id}/run_rta",
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
            params=params,
        )
        # if response.status_code == 202:
        #     print(f"Numerical RTA for well {well_id}")
        # else:
        #     print(response.text)
        return response

    def run_numerical_rta_autofit(self, well_id: int) -> requests.Response:
        """
        Runs the numerical rate transient analysis (NRTA) autofit for a specified well.

        This method sends a request to the Whitson API to perform an autofit NRTA on the well
        identified by `well_id`.

        Parameters:
        ----------
        well_id : int
            The ID of the well for which to run the NRTA autofit.
        """

        response = requests.get(
            f"http://{self.client_name}.whitson.com//api-external/v1/wells/{well_id}/autofit_rta",
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
        )
        # time.sleep(0.05)
        # if response.status_code == 200:
        #     print(f"Numerical RTA Autofit successful for well {well_id}")
        # else:
        #     print(response.text)
        return response

    def _run_nrta_autofit_on_all_wells_in_project(self, project_id: int, sleep_time: int = 0):
        """
        Runs the numerical rate transient analysis (NRTA) autofit for all wells in a specified project.

        This method retrieves all wells associated with the given `project_id` and performs an NRTA autofit
        on each well.

        Parameters:
        ----------
        project_id : int
            The ID of the project for which to run the NRTA autofit on all wells.

        sleep_time : int, optional
        The amount of time to wait (in seconds) between processing each well. Defaults to 0.
        """

        wells = self.get_wells(project_id)
        for well in wells:
            time.sleep(sleep_time)
            well_id = well["id"]
            self.run_numerical_rta_autofit(well_id)

    def _update_nrta_input_parameters(self, min_values, max_values, params):
        """
        Update NRTA input parameters with small random variations.

        This method adjusts each parameter by adding a random value within a defined
        jump size range, ensuring the updated parameters remain within specified minimum
        and maximum values.

        Parameters
        ----------
        min_values : list or array-like
            The minimum values for each parameter.
        max_values : list or array-like
            The maximum values for each parameter.
        params : list or array-like
            The current parameters to be updated.

        Returns
        -------
        tuple
            A tuple of updated parameters, each adjusted by a small random amount
            and constrained within the provided minimum and maximum values.
        """
        # Define the jump size
        jump_size = [
            (max_val - min_val) / 5 for min_val, max_val in zip(min_values, max_values)
        ]

        # Update each parameter with a small random amount within its specified range
        updated_parameters = [
            param + random.uniform(-jump, jump)
            for param, jump in zip(params, jump_size)
        ]

        # Ensure the updated values stay within the specified range
        updated_parameters = [
            max(min_val, min(max_val, updated_param))
            for updated_param, min_val, max_val in zip(
                updated_parameters, min_values, max_values
            )
        ]

        return tuple(updated_parameters)


    def _get_total_project_error(self, project_id: int, weights: dict):
        """
        Calculate the total project error and individual well errors for a given project.

        This method computes the total error for a project by aggregating individual well 
        errors. It also returns the LFP (Last Flowing Pressure) and OOIP (Original Oil in Place) 
        values for each well.

        Parameters
        ----------
        project_id : int
            The unique identifier of the project for which the error is being calculated.
        weights : dict
            A dictionary containing weights for different error components used in the 
            error calculation.

        Returns
        -------
        tuple
            A tuple containing:
            - error (float): The average total error for the project.
            - individual_errors (list of float): The average individual errors for each well.
            - lfps (list of float): The Last Flowing Pressure values for each well.
            - ooips (list of float): The Original Oil in Place values for each well.
        """
        wells = self.get_wells(project_id)

        error = 0
        cumulative_individual_errors = []
        lfps = []
        ooips = []

        all_nrta_data = self._get_nrta_outputs_for_project(project_id)
        all_nrta_data = sorted(all_nrta_data, key=lambda x: x["well_id"])

        lfps = [entry["lfp"] for entry in all_nrta_data]
        ooips = [entry["ooip"] for entry in all_nrta_data]

        get_all_errors_in_project = self._get_all_errors_in_project(project_id)

        for well in get_all_errors_in_project:
            this_error, individual_errors = self._get_nrta_error(well, weights)
            error += this_error

            if not cumulative_individual_errors:
                cumulative_individual_errors = individual_errors
            else:
                cumulative_individual_errors = [
                    sum(x) for x in zip(cumulative_individual_errors, individual_errors)
                ]

        error = error / len(wells)
        individual_errors = [
            error / len(wells) for error in cumulative_individual_errors
        ]

        return error, individual_errors, lfps, ooips


    def _get_nrta_outputs_for_project(self, project_id: int):
        """
        Retrieve NRTA outputs for a specific project.

        This method fetches LFP (Last Flowing Pressure), OOIP (Original Oil in Place),
        OGIP (Original Gas in Place), and OGIP_a for the given project using the API.

        Parameters
        ----------
        project_id : int
            The unique identifier of the project.

        Returns
        -------
        list
            A list of dictionaries containing NRTA output data for each well in the project.

        Raises
        ------
        Exception
            If no wells are found for the given project.
        """
        base_url = (
            f"http://{self.client_name}.whitson.com/api-external/v1/wells/rta_calc"
        )
        response = requests.get(
            base_url,
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
            params={"project_id": project_id},
        )
        res = response.json()
        if not res:
            raise Exception("no existing wells")
        return res

    def _get_all_errors_in_project(self,  project_id : int):
        """
        Retrieve all errors for a specific project.

        This method fetches error data for all wells in the specified project using the API.

        Parameters
        ----------
        project_id : int
            The unique identifier of the project.

        Returns
        -------
        list
            A list of dictionaries containing error data for each well in the project.

        """
        base_url = f"http://{self.client_name}.whitson.com/api-external/v1/wells//rta_autofit_rms"
        response = requests.get(
            base_url,
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            },
            params={"project_id": project_id},
        )
        res = response.json()
        if not res:
            raise Exception("no existing wells")
        return res


    def _get_nrta_error(self, res, weights: dict):
        """
        Calculate NRTA error for a given well.

        This method computes the error for each run based on the provided results and weights.

        Parameters
        ----------
        res : dict
            A dictionary containing the results for a specific well.
        weights : dict
            A dictionary containing weights for different error components.

        Returns
        -------
        tuple
            A tuple containing:
            - tot_error (float): The total calculated error for the well.
            - individual_errors (list of float): The individual error values for each component.
        """

        individual_errors = [value for key, value in res.items()]

        res.pop("well_id", None)

        tot_error = math.log10(
            sum(((weights[key] * value) ) for key, value in res.items())
        )

        return tot_error, individual_errors

    def _append_to_nrta_report(
        self,
        result_df,
        run,
        test_parameters,
        this_error,
        probability_to_accept,
        was_accpeted,
        individual_errors,
        lfps,
        ooips,
    ):
        """
        Append NRTA run results to the report DataFrame.

        This method adds the results of an NRTA run, including test parameters, error metrics,
        and other relevant data, to the provided result DataFrame.

        Parameters
        ----------
        result_df : pd.DataFrame
            The DataFrame to which the results will be appended.
        run : int
            The run identifier.
        test_parameters : list
            The list of test parameters used in the run.
        this_error : float
            The total error for the run.
        probability_to_accept : float
            The probability of accepting the run.
        was_accpeted : bool
            Whether the run was accepted.
        individual_errors : list of float
            The list of individual errors for each error component.
        lfps : list of float
            The Last Flowing Pressure values for the wells.
        ooips : list of float
            The Original Oil in Place values for the wells.

        Returns
        -------
        pd.DataFrame
            The updated result DataFrame with the new run results appended.
        """    
        warnings.simplefilter(action="ignore", category=FutureWarning)
        row = {
            "Run": run,
            "swi": test_parameters[0],
            "fcd": test_parameters[1],
            "swc": test_parameters[2],
            "sorw": test_parameters[3],
            "sorg": test_parameters[4],
            "sgc": test_parameters[5],
            "nw": test_parameters[6],
            "now": test_parameters[7],
            "ng": test_parameters[8],
            "nog": test_parameters[9],
            "Error": this_error,
            "Probability_to_Accept": probability_to_accept,
            "Was_Accepted": was_accpeted,
            "cum_oil_error": individual_errors[4],
            "cum_gas_error": individual_errors[0],
            "cum_water_error": individual_errors[6],
            "cum_gor_error": individual_errors[2],
            "oil_error": individual_errors[5],
            "gas_error": individual_errors[1],
            "water_error": individual_errors[7],
            "gor_error": individual_errors[3],
        }

        row_string = (
            f"{run}, "
            f"{test_parameters[0]:.4f}, "
            f"{test_parameters[1]:.4f}, "
            f"{test_parameters[2]:.4f}, "
            f"{test_parameters[3]:.4f}, "
            f"{test_parameters[4]:.4f}, "
            f"{test_parameters[5]:.4f}, "
            f"{test_parameters[6]:.4f}, "
            f"{test_parameters[7]:.4f}, "
            f"{test_parameters[8]:.4f}, "
            f"{test_parameters[9]:.4f}, "
            f"{this_error:.4f}, "
            f"{probability_to_accept:.4f}, "
            f"{was_accpeted}, "
            f"{individual_errors[4]:.4f}, "
            f"{individual_errors[0]:.4f}, "
            f"{individual_errors[6]:.4f}, "
            f"{individual_errors[2]:.4f}, "
            f"{individual_errors[5]:.4f}, "
            f"{individual_errors[1]:.4f}, "
            f"{individual_errors[7]:.4f}, "
            f"{individual_errors[3]:.4f}"
        )

        print(row_string)

        # Concatenate all lfps and ooips into strings separated by commas
        lfps_str = ", ".join(map(str, lfps))
        ooips_str = ", ".join(map(str, ooips))

        # Add lfps and ooips to the row dictionary
        row["lfps"] = lfps_str
        row["ooips"] = ooips_str

        # Append the row to the result DataFrame
        row_df = pd.DataFrame([row])
        result_df = pd.concat([result_df, row_df], ignore_index=True)

        return result_df

# ---------------------------------------------------------------------------------------------------------
# DCA related Functions
# ---------------------------------------------------------------------------------------------------------

    def get_dca_fits(self, well_id: int) -> requests.Response:
        """
        Get (existing) DCA fits for well {well_id}.

        Example params:
        this_well_id = integer

        Example function call:
        response = whitson_connection.get_dca_fits(this_well_id)
        """
        response = requests.get(
            f"http://{self.client_name}.whitson.com/api-external/v1/wells/{well_id}/well_dca/dca_export",
            headers={
                "content-type": "application/json",
                "Authorization": f"Bearer {self.access_token}",
            }
        )

        if response.status_code == 200:
            print(f"DCA data successfully retrieved for well {well_id}")
        else:
            print("Something went wrong - ", response)

        return response.json()

# ---------------------------------------------------------------------------------------------------------
# SNOWFLAKE Related Functions (https://www.snowflake.com/en/)
# ---------------------------------------------------------------------------------------------------------

    def snowflake_connection(self, account : str, user : str, password, database: str, schema : str ='PUBLIC', warehouse : str ='XS', role : str ='ACCOUNTADMIN'):
        """
        Creates a connection to Snowflake using the provided credentials and parameters.

        Parameters:
        - account (str): The Snowflake account identifier, typically in the format '<account_identifier>.<region>.<cloud_provider>'.
        - user (str): The Snowflake user name.
        - password (str): The password for the Snowflake user.
        - database (str): The name of the Snowflake database to connect to.
        - schema (str): The schema within the database. Default is 'PUBLIC'.
        - warehouse (str): The name of the Snowflake warehouse to use. Default is 'XS'.
        - role (str): The role to use for the connection. Default is 'ACCOUNTADMIN'.

        Returns:
        - connection: A connection object to the Snowflake database.
        """
        engine = create_engine(URL(
            account=account,
            user=user,
            password=password,
            database=database,
            schema=schema,
            warehouse=warehouse,
            role=role
        ))

        return engine.connect()

    def snowflake_table_to_dataframe(self, snowflake_connection, snowflake_query: str) -> pd.DataFrame:
        """
        Executes a query on a Snowflake connection and returns the result as a pandas DataFrame.

        Parameters:
        - snowflake_connection: An active SQLAlchemy connection object to Snowflake.
        - snowflake_query (str): The SQL query to execute on the Snowflake database.

        Returns:
        - pd.DataFrame: A pandas DataFrame containing the results of the executed query.

        Example:
        >>> connection = create_snowflake_connection(account='your_account', user='your_user', password='your_password', database='your_database')
        >>> query = "SELECT * FROM your_database.your_schema.your_table"
        >>> df = snowflake_table_to_dataframe(connection, query)
        >>> print(df.head())

        Notes:
        - Ensure that the Snowflake connection is active and properly configured before calling this function.
        - The function fetches all rows from the result set, so be mindful of the query size to avoid memory issues.
        """
        result = snowflake_connection.execute(snowflake_query)
        rows = result.fetchall()
        columns = result.keys()
        return pd.DataFrame(rows, columns=columns)

# ---------------------------------------------------------------------------------------------------------
# PRODMAN related Functions (https://prodman.ca/)
# ---------------------------------------------------------------------------------------------------------

    def prodman_get_wells(self, domain: str, api_key: str) -> json:
        """
        Fetches well data from the Prodman API for a given domain.

        This function sends a GET request to the Prodman API, using the provided domain and API key, 
        to retrieve a list of wells in JSON format. The function returns the parsed JSON response if 
        the request is successful, otherwise, it prints an error message and returns an empty list.

        Args:
            domain (str): The domain name to be used in the API request URL (e.g., 'example' for 'https://example.prodman.ca').
            api_key (str): The API key required for authentication to access the Prodman API.

        Returns:
            json: A list of well data in JSON format if the request is successful. 
            If the request fails, an empty list is returned.

        More info about PRODMAN api can be found at https://YOURCOMPANYDOMAIN.prodman.ca/api/help.
        """
        params = {
            'api_key': api_key
        }

        url = f"https://{domain}.prodman.ca/api/wells/&return-type=json"
        response = requests.get(url, params=params)

        if response.status_code == 200:
            content = response.content.decode('utf-8')
            return json.loads(content)
        else: 
            print(f"Error: {response.status_code}")
            return []

    def prodman_get_production(self, domain: str, api_key: str) -> json:
        """
        Fetches production data from the Prodman API for all wells within a specified date range.

        This function sends a GET request to the Prodman API, using the provided domain and API key,
        to retrieve production data for all wells. The data includes fields such as `entity_id`, `date`,
        `oil`, `gas`, and `water`. The results are returned in JSON format. If the request fails, the 
        function prints an error message and returns an empty list.

        Args:
            domain (str): The domain name to be used in the API request URL (e.g., 'example' for 'https://example.prodman.ca').
            api_key (str): The API key required for authentication to access the Prodman API.

        Returns:
            json: A list of production data in JSON format if the request is successful.
            If the request fails, an empty list is returned.

        More info about PRODMAN api can be found at https://YOURCOMPANYDOMAIN.prodman.ca/api/help.
        """

        params = {
            'api_key': api_key, 
            'well_id': 'all',
            'start': '2000-01-01', 
            'end': datetime.today().strftime('%Y-%m-%d'),
            'fields': 'entity_id, date, oil, gas, water, casing, tubing',
            'units': 'us',
            'return-type': 'json'
        }

        url = f"https://{domain}.prodman.ca/api/production/"
        response = requests.get(url, params=params)

        if response.status_code == 200:
            content = response.content.decode('utf-8')
            return json.loads(content)
        else: 
            print(f"Error: {response.status_code}")
            return []

    def propman_canada_uwi_cleanup(self, uwi: str) -> str:
        """
        Cleans up a UWI string for Propman Canada.

        This function performs the following steps:
        1. Removes all occurrences of '-' and '/' from the input UWI string.
        2. Ensures the cleaned UWI string starts with '1'. If it does not, '1' is added at the beginning.
        3. Pads the UWI string with '0's at the end to make it exactly 16 characters long if it has fewer than 16 characters.
        4. Prints the processed UWI if modifications are made.
        5. Prints a warning if the cleaned UWI is already 16 characters or more without needing modifications.

        Parameters:
        uwi (str): The input UWI string to be cleaned and formatted.

        Returns:
        str: The cleaned and formatted UWI string.
        """
        # Replace '/' and '-' with an empty string using str.replace
        cleaned_uwi = uwi.replace('/', '').replace('-', '')

        # Ensure the UWI starts with '1'
        if not cleaned_uwi.startswith('1'):
            cleaned_uwi = '1' + cleaned_uwi

        # If the length is less than 16, pad with '0' at the end
        if len(cleaned_uwi) == 15:
            cleaned_uwi = cleaned_uwi.ljust(16, '0')
            print(f"Processed UWI: {cleaned_uwi}")
            return cleaned_uwi
        elif len(cleaned_uwi) == 16:
            return cleaned_uwi 
        else:
            # print("Warning: The processed UWI already meets the requirements or is longer than 16 characters.")
            return cleaned_uwi

# ---------------------------------------------------------------------------------------------------------
# General Functions
# ---------------------------------------------------------------------------------------------------------

    def round_to_significant_digits(self, number: float, digits: int = 4) -> float:
        """
        Rounds a number to the specified number of significant digits.

        Parameters:
        -----------
        number : float
            The number to be rounded.
        digits : int
            The number of significant digits to round to.

        Returns:
        --------
        float
            The number rounded to the specified number of significant digits.
            Returns 0 if the input number is 0 to avoid log10 errors.

        Examples:
        ---------
        >>> round_to_significant_digits(12345.6789, 3)
        12300

        >>> round_to_significant_digits(0.012345, 4)
        0.01235

        Notes:
        ------
        This function uses logarithmic calculations to determine the
        appropriate rounding level for the desired number of significant
        digits. It handles zero input separately to avoid mathematical
        issues with logarithms of zero.
        """
        if number == 0:
            return 0  # Return 0 if the input is 0 to avoid log10 issues

        significant_digits = digits - int(math.floor(math.log10(abs(number)))) - 1
        return round(number, significant_digits)

## Done

We'll routinely add to this class to improve the usability of the endpoints and simplify eAPI workflows further. Feel free to send your feedback/wishlist at support@whitson.com.

Getting Started

After downloading the helper class above, you can import it into your script as shown below. You can request us (at support@whitson.com) to provide the client id and client secret or the key contact in your company, who confidentially maintains the client id and client secret values used for your company. This will be used to generate an authorization token which can be used for 24 hours, so please be mindful about the number of times you use the get_access_token() function on line 46.

The script below is an example of how to create a WhitsonConnection class object and use one of the functions to retrieve all the well header information stored in the database for all the wells in the project.

import whitson_connect

# To fill
CLIENT = "your_domain_here" #This is the company suffix in your whitson urls ex. 'courses' in courses.whitson.com
CLIENT_ID = "your_client_id_here" # Available on request
CLIENT_SECRET = "your_client_secret" # Available on request
PROJECT_ID = "your_project_id_here" # This is the numeric value of the project, available from the URL like '638' in https://courses.whitson.com/fields/5/projects/638/

## Creating a WhitsonConnection class object
whitson_connection = whitson_connect.WhitsonConnection(
    CLIENT, CLIENT_ID, CLIENT_SECRET
)

## Issuing an authorization token here - automatically saves the access token in the working directory so only one token is issued every 24 hours.
whitson_connection.access_token = whitson_connection.get_access_token_smart()

## Get all the wells in the project
whitson_wells = whitson_connection.get_wells(PROJECT_ID)

print(whitson_wells)