Skip to content
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.

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

Pv wip #36

Closed
wants to merge 9 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ repos:
- id: end-of-file-fixer
exclude: tests/testdata
- id: trailing-whitespace
exclude: tests/testdata/well_trajectory/spe1case1/expected
exclude: tests/testdata/well_trajectory/.*/expected
- repo: https://github.com/charliermarsh/ruff-pre-commit
rev: v0.1.2
hooks:
Expand Down
9 changes: 4 additions & 5 deletions docs/reference/add_templates/config.yml
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
# -c/--config specification:
# '...' are REQUIRED fields that needs replacing
# <REPLACE> is a REQUIRED field that needs replacing


# Datatype: [Template map]
# Required: True
templates:
-
-

# File path to jinja template
# Datatype: Path
# Examples: /path/to/file.ext, /path/to/directory/
# Required: True
file: '...' # ← REPLACE
file: <REPLACE>

# Datatype: Keys
# Examples: {opname: KBD, phase: WATER, <field>: <value>}
# Required: False
keys: {}
keys: {}
76 changes: 33 additions & 43 deletions docs/reference/compute_economics/config.yml
Original file line number Diff line number Diff line change
@@ -1,28 +1,27 @@
# -c/--config specification:
# '...' are REQUIRED fields that needs replacing
# <REPLACE> is a REQUIRED field that needs replacing


# Datatype: {string: [CurrencyRate map]}
# Required: True
prices:
<string>:
-
<STRING>:
-

# Datatype: number
# Examples: .1, 1., 1, 1.0, 1.34E-5, 1.34e-5
# Required: True
value: '...' # ← REPLACE
value: <REPLACE>

# Datatype: string
# Examples: a string value
# Required: False
# Default: null
currency: null
currency: null

# Datatype: date
# Examples: 2024-01-31, 2024-01-31T11:06
# Required: True
date: '...' # ← REPLACE
date: <REPLACE>

# Datatype: integer
# Examples: .1, 1., 1, 1.0, 1.34E-5, 1.34e-5
Expand All @@ -42,7 +41,6 @@ default_exchange_rate: 1
# Default: 0.08
default_discount_rate: 0.08

# Datatype: Dates map
# Required: False
dates:

Expand All @@ -64,99 +62,94 @@ dates:
# Default: null
ref_date: null

# Datatype: {string: [CurrencyRate map]}
# Required: False
exchange_rates:
<string>:
-
<STRING>:
-

# Datatype: number
# Examples: .1, 1., 1, 1.0, 1.34E-5, 1.34e-5
# Required: True
value: '...' # ← REPLACE
value: <REPLACE>

# Datatype: string
# Examples: a string value
# Required: False
# Default: null
currency: null
currency: null

# Datatype: date
# Examples: 2024-01-31, 2024-01-31T11:06
# Required: True
date: '...' # ← REPLACE
date: <REPLACE>

# Datatype: [CurrencyRate map]
# Required: False
discount_rates:
-
-

# Datatype: number
# Examples: .1, 1., 1, 1.0, 1.34E-5, 1.34e-5
# Required: True
value: '...' # ← REPLACE
value: <REPLACE>

# Datatype: string
# Examples: a string value
# Required: False
# Default: null
currency: null
currency: null

# Datatype: date
# Examples: 2024-01-31, 2024-01-31T11:06
# Required: True
date: '...' # ← REPLACE
date: <REPLACE>

# Datatype: [CurrencyRate map]
# Required: False
costs:
-
-

# Datatype: number
# Examples: .1, 1., 1, 1.0, 1.34E-5, 1.34e-5
# Required: True
value: '...' # ← REPLACE
value: <REPLACE>

# Datatype: string
# Examples: a string value
# Required: False
# Default: null
currency: null
currency: null

# Datatype: date
# Examples: 2024-01-31, 2024-01-31T11:06
# Required: True
date: '...' # ← REPLACE
date: <REPLACE>

# Datatype: [WellCost map]
# Required: False
well_costs:
-
-

# Datatype: number
# Examples: .1, 1., 1, 1.0, 1.34E-5, 1.34e-5
# Required: True
value: '...' # ← REPLACE
value: <REPLACE>

# Datatype: string
# Examples: a string value
# Required: False
# Default: null
currency: null
currency: null

# Datatype: string
# Examples: a string value
# Required: True
well: '...' # ← REPLACE
well: <REPLACE>

# Datatype: EclipseSummaryConfig map
# Required: True
summary:

# Datatype: Path
# Examples: /path/to/file.ext, /path/to/directory/
# Required: True
main: '...' # ← REPLACE
main: <REPLACE>

# Datatype: Path
# Examples: /path/to/file.ext, /path/to/directory/
Expand All @@ -167,64 +160,61 @@ summary:
# Datatype: [string]
# Required: False
keys:
- '...'
- <REPLACE>

# Datatype: Path
# Examples: /path/to/file.ext, /path/to/directory/
# Required: False
# Default: null
wells_input: null

# Datatype: OutputConfig map
# Required: True
output:

# Datatype: Path
# Examples: /path/to/file.ext, /path/to/directory/
# Required: True
file: '...' # ← REPLACE
file: <REPLACE>

# Datatype: string
# Examples: a string value
# Required: False
# Default: null
currency: null

# Datatype: [CurrencyRate map]
# Required: False
# Default: null
currency_rate:
-
-

# Datatype: number
# Examples: .1, 1., 1, 1.0, 1.34E-5, 1.34e-5
# Required: True
value: '...' # ← REPLACE
value: <REPLACE>

# Datatype: string
# Examples: a string value
# Required: False
# Default: null
currency: null
currency: null

# Datatype: date
# Examples: 2024-01-31, 2024-01-31T11:06
# Required: True
date: '...' # ← REPLACE
date: <REPLACE>

# Datatype: OilEquivalentConversionConfig map
# Required: False
# Default: null
oil_equivalent:

# Datatype: {string: number}
# Required: True
oil:
<string>: '...'
<STRING>: <REPLACE>

# Datatype: {string: {string: number}}
# Required: False
# Default: null
remap:
<string>:
<string>: '...'
<STRING>:
<STRING>: <REPLACE>
6 changes: 4 additions & 2 deletions docs/reference/doc_schemas.py
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#! /usr/bin/env python
import contextlib
import os
import pathlib
import re
Expand Down Expand Up @@ -87,8 +86,11 @@ def main(args: Optional[Sequence[str]] = None) -> None:
args_parser = build_argument_parser()
options = args_parser.parse_args(args)
for job in forward_models(options.forward_models):
with contextlib.suppress(subprocess.CalledProcessError):
try:
write_to_reference_docs(job, options.output_directory)
except subprocess.CalledProcessError as exc:
if "--schema" in " ".join(exc.cmd) and "usage:" in str(exc.output):
print(f"Skipping `{job}`: no schema generator implemented")


if __name__ == "__main__":
Expand Down
50 changes: 23 additions & 27 deletions docs/reference/drill_planner/config.yml
Original file line number Diff line number Diff line change
@@ -1,84 +1,80 @@
# -c/--config specification:
# '...' are REQUIRED fields that needs replacing
# <REPLACE> is a REQUIRED field that needs replacing


# Datatype: date
# Examples: 2024-01-31, 2024-01-31T11:06
# Required: True
start_date: '...' # ← REPLACE
start_date: <REPLACE>

# Datatype: date
# Examples: 2024-01-31, 2024-01-31T11:06
# Required: True
end_date: '...' # ← REPLACE
end_date: <REPLACE>

# Datatype: [Rig map]
# Required: True
rigs:
-
-

# Datatype: string
# Examples: a string value
# Required: True
name: '...' # ← REPLACE
name: <REPLACE>

# Datatype: [string]
# Required: False
wells:
- '...'
wells:
- <REPLACE>

# Datatype: [Unavailability map]
# Required: False
unavailability:
-
unavailability:
-

# Datatype: date
# Examples: 2024-01-31, 2024-01-31T11:06
# Required: True
start: '...' # ← REPLACE
start: <REPLACE>

# Datatype: date
# Examples: 2024-01-31, 2024-01-31T11:06
# Required: True
stop: '...' # ← REPLACE
stop: <REPLACE>

# Datatype: [string]
# Required: False
slots:
- '...'
slots:
- <REPLACE>

# Datatype: integer
# Examples: 1, 1.34E5, 1.34e5
# Examples: 1, 1.34E5
# Required: False
# Default: 0
delay: 0
delay: 0

# Datatype: [Slot map]
# Required: False
slots:
-
-

# Datatype: string
# Examples: a string value
# Required: True
name: '...' # ← REPLACE
name: <REPLACE>

# Datatype: [string]
# Required: False
wells:
- '...'
wells:
- <REPLACE>

# Datatype: [Unavailability map]
# Required: False
unavailability:
-
unavailability:
-

# Datatype: date
# Examples: 2024-01-31, 2024-01-31T11:06
# Required: True
start: '...' # ← REPLACE
start: <REPLACE>

# Datatype: date
# Examples: 2024-01-31, 2024-01-31T11:06
# Required: True
stop: '...' # ← REPLACE
stop: <REPLACE>
Loading
Loading