Repository navigation
Expand file tree
/
Copy pathmkdocs.yml
More file actions
142 lines (136 loc) · 5.26 KB
/
Copy pathmkdocs.yml
File metadata and controls
142 lines (136 loc) · 5.26 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
site_name: quick_pp
site_description: Comprehensive Python package and web platform for deterministic and probabilistic petrophysical evaluation, SCAL & relative permeability modeling, multi-well FWL optimization, stratigraphic normalization, and geomodel log upscaling.
site_author: Imran Fadhil
site_url: https://quick-pp.readthedocs.io/
repo_url: https://github.com/imranfadhil/quick_pp
repo_name: imranfadhil/quick_pp
edit_uri: blob/main/docs/
theme:
name: material
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: teal
accent: amber
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: teal
accent: amber
toggle:
icon: material/brightness-4
name: Switch to light mode
features:
- navigation.tabs
- navigation.sections
- navigation.expand
- navigation.top
- navigation.indexes
- search.suggest
- search.highlight
- content.code.copy
- content.code.annotate
- toc.follow
hooks:
- docs/hooks.py
plugins:
- search
- mkdocs-jupyter:
include:
- "tutorials/*.ipynb"
execute: false
include_source: true
ignore_h1_titles: true
- mkdocstrings:
default_handler: python
handlers:
python:
paths: [.]
options:
docstring_style: google
show_source: true
show_root_heading: true
show_root_full_path: false
show_symbol_type_heading: true
show_symbol_type_toc: true
members_order: source
separate_signature: true
show_signature_annotations: true
signature_crossrefs: true
filters:
- "!^_"
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.highlight:
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.tabbed:
alternate_style: true
- pymdownx.arithmatex:
generic: true
- attr_list
- md_in_html
- tables
- toc:
permalink: true
extra_javascript:
- javascripts/mathjax.js
- https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js
nav:
- Home: index.md
- Getting Started:
- Installation: getting-started/installation.md
- Quickstart & CLI: getting-started/usage.md
- AI Assistant & MCP: getting-started/ai-assistant.md
- Workflows & Technical Foundations:
- Overview: workflows/index.md
- Single-Well Petrophysics: workflows/single_well.md
- Multi-Well Field Evaluation: workflows/multi_well.md
- Visual Tutorials (Notebooks):
- Overview: tutorials/index.md
- "04 — FDP & PIML Showcase":
- Master FDP & PIML Showcase: tutorials/04_fdp_and_piml_showcase.ipynb
- "04.1 Probabilistic CPI & FWL Optimization": tutorials/04_1_probabilistic_cpi_and_fwl_optimization.ipynb
- "04.2 SCAL, RelPerm & Log Blocking": tutorials/04_2_scal_relperm_and_log_blocking.ipynb
- "04.3 PIML & Conformal Prediction": tutorials/04_3_piml_and_conformal_prediction.ipynb
- "03 — Deterministic & Carbonate Workflows":
- "03.1 Carbonate Lithology & Porosity": tutorials/03_1_carbonate_lithology_porosity.ipynb
- "03.2 Carbonate Rock Typing (FZI)": tutorials/03_2_carbonate_rock_typing_fzi.ipynb
- "03.3 Carbonate Saturation (J-Function)": tutorials/03_3_carbonate_saturation_j_fzi.ipynb
- "03.4 Carbonate Single-Well Evaluation": tutorials/03_4_carbonate_single.ipynb
- "03.5 Carbonate Multi-Well Batch": tutorials/03_5_carbonate_batch.ipynb
- "03.6 Carbonate Volume Uncertainty": tutorials/03_6_carbonate_volume_uncertainty.ipynb
- "Clastic Sand-Silt-Clay (Single Well)": tutorials/03_qpp_ssc_single.ipynb
- "Clastic Sand-Silt-Clay (Multi-Well Batch)": tutorials/03_qpp_ssc_batch.ipynb
- "Sand-Shale Evaluation": tutorials/03_qpp_ss_single.ipynb
- "Thin-Bed Evaluation": tutorials/03_qpp_ts_single.ipynb
- API Reference:
- Package Overview: api/overview.md
- QA/QC & Normalization (qaqc): api/qaqc.md
- Raw Log Resolution Enhancement (conditioning): api/conditioning.md
- Lithology Inversion (lithology): api/lithology.md
- Porosity (porosity): api/porosity.md
- Saturation & FWL Optimizer (saturation): api/saturation.md
- Permeability (permeability): api/permeability.md
- Rock & Fluid Typing (rock_type): api/rock_type.md
- Core Analysis (core_analysis): api/core_analysis.md
- SCAL & Relative Permeability (scal): api/scal.md
- Uncertainty & Monte Carlo (uncertainty): api/uncertainty.md
- Log Blocking & Upscaling (upscaling): api/upscaling.md
- Reservoir Summary (ressum): api/ressum.md
- Rock Physics (rock_physics): api/rock_physics.md
- Machine Learning & Conformal (machine_learning): api/machine_learning.md
- Plotting, LAS, Handover & Utilities: api/plotter.md
- Community:
- Contributing: community/contributing.md
- Changelog: community/changelog.md
- Credits: community/authors.md