Skip to content

Fix rendering of storage input data docs #278

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Robbybp wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix rendering of storage input data docs #278

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2427c12
update docs/data-format
Robbybp Dec 9, 2025
9fe4b55
Merge branch 'master' into docs
Robbybp Dec 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
GasModels = "5e113713-6c35-5477-b766-e1109486666f"

[compat]
Documenter = "0.27"
43 changes: 22 additions & 21 deletions docs/src/data-format.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,27 +221,28 @@ These components model producers (providers) of natural gas.
## Storage (mgc.storage)

These components are used to model locations which can store and release natural gas.
| Variable | Type | Name | Standard Units (SI) | United States Customary Units | Required | Description |
| ------------------------ | ------- | ------------------------ | ------------------- | ----------------------------- | ------------------ | --------------------------------------------------------------- |
| id | Int | Storage id | | | Y | Unique id for storage |
| junction_id | Int | Junction id | | | Y | Unique id of Junction to which component is connected |
| pressure_nominal | Float64 | Nominal pressure | Pascal | PSI | Y | pressure at the storage |
| flow\_injection\_rate\_min | Float64 | Minimum injection rate | kg/s | MMSCFD | Y | Minimum flow injection rate |
| flow\_injection\_rate\_max | Float64 | Maximum injection rate | kg/s | MMSCFD | Y | Maximum flow injection rate |
| flow\_withdrawal\_rate\_min | Float64 | Minimum withdrawal rate | kg/s | MMSCFD | Y | Minimum flow withdrawal rate |
| flow\_withdrawal\_rate\_max | Float64 | Maximum withdrawal rate | kg/s | MMSCFD | Y | Maximum flow withdrawal rate |
| capacity | Float64 | Capacity | kg | MMSCF | Y | Capacity of the storage |
| status | Int | Storage status | | | Y | Determines if the component is active in the model |
| name | String | Storage Name | | | | Name of the Storage point |
| owner_name | String | Owner Name | | | | Name of the Storage point owner |
| storage_type | String | Storage type | | | | Type of storage (aquifer, salt cavern, or depleted oil and gas) |
| daily\_withdrawal\_max | Float64 | Daily withdrawal rate | kg/s | MMSCFD | | Maximum daily withdrawal |
| seasonal\_withdrawal\_max | Float64 | Seasonal withdrawal rate | kg/s | MMSCFD | | Maximum Seasonal withdrawal |
| base\_gas\_capacity | Float64 | Base gas capacity | kg | MMSCF | | Base gas capacity |
| working\_gas\_capacity | Float64 | Working gas capacity | kg | MMSCF | | Working gas capacity |
| total\_field\_capacity | Float64 | Total field capacity | kg | MMSCF | | Total field gas capacity |
| initial_field_capacity_percent | Float64 | Initial field capacity fraction | — | — | Y | Fraction (0 to 1) of total field capacity initially filled; despite the name, this value is a fraction, not a percentage. |
| edi_id | Int | EDI ID | | | | Unique ID to allow easy input of near-real-time EDI data |

| Variable | Type | Name | Standard Units (SI) | United States Customary Units | Required | Description |
| --------------------------- | ------- | ------------------------ | ------------------- | ----------------------------- | ------------------ | --------------------------------------------------------------- |
| id | Int | Storage id | | | Y | Unique id for storage |
| junction\_id | Int | Junction id | | | Y | Unique id of Junction to which component is connected |
| pressure\_nominal | Float64 | Nominal pressure | Pascal | PSI | Y | pressure at the storage |
| flow\_injection\_rate\_min | Float64 | Minimum injection rate | kg/s | MMSCFD | Y | Minimum flow injection rate |
| flow\_injection\_rate\_max | Float64 | Maximum injection rate | kg/s | MMSCFD | Y | Maximum flow injection rate |
| flow\_withdrawal\_rate\_min | Float64 | Minimum withdrawal rate | kg/s | MMSCFD | Y | Minimum flow withdrawal rate |
| flow\_withdrawal\_rate\_max | Float64 | Maximum withdrawal rate | kg/s | MMSCFD | Y | Maximum flow withdrawal rate |
| capacity | Float64 | Capacity | kg | MMSCF | Y | Capacity of the storage |
| status | Int | Storage status | | | Y | Determines if the component is active in the model |
| name | String | Storage Name | | | | Name of the Storage point |
| owner\_name | String | Owner Name | | | | Name of the Storage point owner |
| storage\_type | String | Storage type | | | | Type of storage (aquifer, salt cavern, or depleted oil and gas) |
| daily\_withdrawal\_max | Float64 | Daily withdrawal rate | kg/s | MMSCFD | | Maximum daily withdrawal |
| seasonal\_withdrawal\_max | Float64 | Seasonal withdrawal rate | kg/s | MMSCFD | | Maximum Seasonal withdrawal |
| base\_gas\_capacity | Float64 | Base gas capacity | kg | MMSCF | | Base gas capacity |
| working\_gas\_capacity | Float64 | Working gas capacity | kg | MMSCF | | Working gas capacity |
| total\_field\_capacity | Float64 | Total field capacity | kg | MMSCF | | Total field gas capacity |
| initial\_field\_capacity\_percent | Float64 | Initial field capacity fraction | — | — | Y | Fraction (0 to 1) of total field capacity initially filled; despite the name, this value is a fraction, not a percentage. |
| edi\_id | Int | EDI ID | | | | Unique ID to allow easy input of near-real-time EDI data |

## Network Parameters (mgc._parameter_)

Expand Down