Stream Properties Overview
This document explains how stream-properties is used to represent the properties of different streams in an economic model. The main properties (econ functions) include yields, shrinkage, lossFlare, and btuContent. These four properties are required for a Stream Properties model.
Example Response
{
"id": "645bfbb941f57aafd4356e2f",
"copiedFrom": null,
"name": "Stream Properties Demo",
"tags": [],
"unique": false,
"createdBy": "6234d6677118ecb7e6fd699a",
"lastUpdatedBy": "6234d6677118ecb7e6fd699a",
"createdAt": "2023-05-10T20:16:57.378Z",
"updatedAt": "2023-05-10T20:16:57.378Z",
"yields": {
"rateType": "gross_well_head",
"rowsCalculationMethod": "monotonic",
"ngl": {
"rows": [
{
"gasRate": 8,
"shrunkGas": "Shrunk Gas",
"yield": 0.000001
},
{
"gasRate": 15,
"shrunkGas": "Shrunk Gas",
"yield": 9
},
{
"gasRate": 16,
"shrunkGas": "Shrunk Gas",
"yield": 9
}
]
},
"dripCondensate": {
"rows": [
{
"offsetToFpd": 99,
"unshrunkGas": "Unshrunk Gas",
"yield": 2001
}
]
}
},
"shrinkage": {
"rateType": "gross_well_head",
"rowsCalculationMethod": "non_monotonic",
"oil": {
"rows": [
{
"gasRate": 123132132,
"pctRemaining": 100
}
]
},
"gas": {
"rows": [
{
"entireWellLife": "Flat",
"pctRemaining": 100
}
]
}
},
"lossFlare": {
"rateType": "gross_well_head",
"rowsCalculationMethod": "non_monotonic",
"oilLoss": {
"rows": [
{
"entireWellLife": "Flat",
"pctRemaining": 100
}
]
},
"gasLoss": {
"rows": [
{
"offsetToFpd": 24,
"pctRemaining": 100
}
]
},
"gasFlare": {
"rows": [
{
"dates": "2020-10-01",
"pctRemaining": 100
}
]
}
},
"btuContent": {
"unshrunkGas": 1231.999999999,
"shrunkGas": 999.999
}
}
Econ Functions
yields: (required) This object property includesrowsCalculationMethod(required),ngl(natural gas liquids) (required), anddripCondensate(condensate that falls out of the natural gas) (required).shrinkage: (required) Represents the shrinkage ofoil(required) andgas(required) using specificrowsCalculationMethod(required).lossFlare: (required) Represents the loss and flare ofoil(required) andgas(required) using specificrowsCalculationMethod(required).btuContent: (required) Represents the BTU (British Thermal Units) content of unshrunk and shrunk gas.
yields
rowsCalculationMethod(required) stringngl(required) objectdripCondensate(required) object
ngl and dripCondensate
An object that contains the rows array representing the rows of either ngl or dripCondensate. Each item in the array is an object with one of the following properties from each of the categories:
yield: (required) A number representing the yield value.shrunkGasorunshrunkGas: (one required) Strings representing the types of gas.entireWellLife,offsetToFpd,offsetToAsOf,offsetToFirstSegment,offsetToEndHistory,dates,oilRate,gasRate,waterRate: (one required) Various criteria related to well life and production rates.
"yields": {
"rowsCalculationMethod": "monotonic",
"ngl": {
"rows": [
{
"gasRate": 8,
"shrunkGas": "Shrunk Gas",
"yield": 0.000001
},
{
"gasRate": 15,
"shrunkGas": "Shrunk Gas",
"yield": 9
},
{
"gasRate": 16,
"shrunkGas": "Shrunk Gas",
"yield": 9
}
]
},
"dripCondensate": {
"rows": [
{
"offsetToFpd": 99,
"unshrunkGas": "Unshrunk Gas",
"yield": 2001
}
]
}
}
shrinkage
rowsCalculationMethod(required) string.oil(required) objectgas(required) object
oil and gas
An object that contain the rows array representing the rows of either oil or gas. Each item in the array is an object with one of the following properties from each of the categories:
pctRemaining: (required) A number representing the percentage of the remaining substance.entireWellLife,offsetToFpd,offsetToAsOf,offsetToFirstSegment,offsetToEndHistory,dates,oilRate,gasRate,waterRate: (one required) Various criteria related to well life and production rates.
"shrinkage": {
"rowsCalculationMethod": "non_monotonic",
"oil": {
"rows": [
{
"offsetToFpd": 123132132,
"pctRemaining": 100
}
]
},
"gas": {
"rows": [
{
"entireWellLife": "Flat",
"pctRemaining": 100
}
]
}
}
lossFlare
rowsCalculationMethod(required) string.oilLoss(required) objectgasLoss(required) objectgasFlare(required) object
oil and gas
An object that contain the rows array representing the rows of either oilLoss, gasLoss, or gasFlare . Each item in the array is an object with one of the following properties from each of the categories:
pctRemaining: (required) A number representing the percentage of the remaining substance.entireWellLife,offsetToFpd,offsetToAsOf,offsetToFirstSegment,offsetToEndHistory,dates,oilRate,gasRate,waterRate: (one required) Various criteria related to well life and production rates.
"lossFlare": {
"rowsCalculationMethod": "non_monotonic",
"oilLoss": {
"rows": [
{
"entireWellLife": "Flat",
"pctRemaining": 100
}
]
},
"gasLoss": {
"rows": [
{
"offsetToFirstSegment": 24,
"pctRemaining": 100
}
]
},
"gasFlare": {
"rows": [
{
"dates": "2020-10-01",
"pctRemaining": 100
}
]
}
}
btuContent
An object that represents the BTU (British Thermal Units) content. The two required properties of the object are:
unshrunkGas: (required) A number representing the amount of unshrunk gas.shrunkGas: (required) A number representing the amount of unshrunk gas
Note: Although these properties share the same name as the properties yields they are not the same.
"btuContent": {
"unshrunkGas": 1231.999999999,
"shrunkGas": 999.999
}
Definitions
dates
This is a string property representing a date. The format of the date is YYYY-MM-DD, and the date must fall between 1900-01-01 to 2262-04-01. For the DD portion of the date, the value must be 01.
entireWellLife
This is a string property that can only have the value "Flat".
gasRate
This property represents a range, defined as an integer. The possible range for this value is from 0 to 10000000000 (10,000,000,000) inclusive.
lossFlarePctRemaining
Number representing the percentage of the remaining substance, with a minimum of 0 and maximum of 100. Minimum decimal precision is 0.000001.
oilRate
This property represents a range, defined as an integer. The possible range for this value is from 0 to 10000000000 (10,000,000,000) inclusive.
offsetToAsOf
This property represents a time period, defined as an integer. The possible range for this value is from 1 to 1200, inclusive.
offsetToEndHistory
This property represents a time period, defined as an integer. The possible range for this value is from 1 to 1200, inclusive.
offsetToFirstSegment
This property represents a time period, defined as an integer. The possible range for this value is from 1 to 1200, inclusive.
offsetToFpd
This property represents a time period, defined as an integer. The possible range for this value is from 1 to 1200, inclusive.
rowsCalculationMethod
A string representing the method of calculating rows. Possible values are "monotonic" and "non_monotonic".
shrinkagePctRemaining
Number representing the percentage of the remaining substance, with a minimum of 0 and maximum of 200. Minimum decimal precision is 0.000001.
shrunkGas (BtuContent)
Number representing the amount of shrunk gas in MBTU/MCF, allows decimals, with a minimum of 100 and maximum of 2000.
shrunkGas (yields)
String representing the type of gas. Only possible value is "Shrunk Gas".
unshrunkGas (BtuContent)
Number representing the amount of unshrunk gas in MBTU/MCF, allows decimals, with a minimum of 100 and maximum of 2000.
unshrunkGas (yields)
String representing the type of gas. Only possible value is "Unshrunk Gas".
waterRate
This property represents a range, defined as an integer. The possible range for this value is from 0 to 10000000000 (10,000,000,000) inclusive.
yield
A number representing the yield value, with a minimum of 0 and a maximum of 1000000 (1,000,000). Minimum decimal precision is 0.000001.