diff --git a/.github/workflows/CI.yml b/.github/workflows/CI.yml
index ece6559..5d2de2f 100644
--- a/.github/workflows/CI.yml
+++ b/.github/workflows/CI.yml
@@ -16,10 +16,10 @@ jobs:
with:
fetch-depth: 0
- - name: Set up Python 3.11
+ - name: Set up Python 3.12
uses: actions/setup-python@v2
with:
- python-version: 3.11
+ python-version: 3.12
- name: Install Flow Simulator
run: |
@@ -45,7 +45,7 @@ jobs:
- name: Check code style and linting
run: |
- black --check src/ tests/ examples/
+ black --target-version py312 --check src/ tests/ examples/
pylint src/ tests/ examples/
mypy --ignore-missing-imports src/ tests/ examples/
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 6e037f0..f96b1d3 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -13,12 +13,12 @@ Contributions are more than welcome using the fork and pull request approach
1. Work on your own fork of the main repo
1. In the main repo execute:
1. **pip install -r dev-requirements.txt** (this installs the [_dev-requirements.txt_](https://github.com/cssr-tools/expreccs/blob/main/dev-requirements.txt))
- 1. **black src/ tests/** (this formats the code)
+ 1. **black --target-version py312 src/ tests/** (this formats the code)
1. **pylint src/ tests/** (this analyses the code, and might rise issues that need to be fixed before the pull request)
1. **mypy --ignore-missing-imports src/ tests/** (this is a static checker, and might rise issues that need to be fixed before the pull request)
1. **pytest --cov=expreccs --cov-report term-missing tests/** (this runs locally the tests, and might rise issues that need to be fixed before the pull request)
1. **pushd docs & make html** (this generates the documentation, and might rise issues that need to be fixed before the pull request; if the build succeeds and if the contribution changes the documentation, then copy all content from the docs/_build/html/ folder and replace the files in the [_docs_](https://github.com/cssr-tools/expreccs/tree/main/docs) folder)
- * Tip for Linux users: See the [_CI.yml_](https://github.com/cssr-tools/expreccs/blob/main/.github/workflows/CI.yml) script and the [_Actions_](https://github.com/cssr-tools/expreccs/actions) for installation of expreccs, OPM Flow (binary packages), and dependencies, as well as the execution of the six previous steps in Ubuntu 24.04 using Python 3.11.
+ * Tip for Linux users: See the [_CI.yml_](https://github.com/cssr-tools/expreccs/blob/main/.github/workflows/CI.yml) script and the [_Actions_](https://github.com/cssr-tools/expreccs/actions) for installation of expreccs, OPM Flow (binary packages), and dependencies, as well as the execution of the six previous steps in Ubuntu 24.04 using Python 3.12.
* Tip for macOS users: See the [_ci_pycopm_macos_.yml_](https://github.com/daavid00/OPM-Flow_macOS/blob/main/.github/workflows/ci_pycopm_macos.yml) script and the [_OPM-Flow_macOS Actions_](https://github.com/cssr-tools/pycopm/actions) for installation of pycopm (a related tool to expreccs), OPM Flow (source build), and dependencies in macOS 26 using Python 3.13. In addition, you need to add the directory containing the OPM Flow executable to your system's PATH environment variable (e.g., export PATH=$PATH:/Users/yourname/pyopmspe11/build/opm-simulators/bin).
1. Squash your commits into a single commit (see this [_nice tutorial_](https://gist.github.com/lpranam/4ae996b0a4bc37448dc80356efbca7fa) if you are not familiar with this)
1. Push your commit and make a pull request
diff --git a/docs/_sources/contributing.rst.txt b/docs/_sources/contributing.rst.txt
index 5c81b31..7e66712 100644
--- a/docs/_sources/contributing.rst.txt
+++ b/docs/_sources/contributing.rst.txt
@@ -22,14 +22,14 @@ Contribute to the software
#. In the main repo execute:
#. **pip install -r dev-requirements.txt** (this installs the `dev-requirements.txt pip install -r dev-requirements.txt (this installs the dev-requirements.txt) black src/ tests/ (this formats the code) black –target-version py312 src/ tests/ (this formats the code) pylint src/ tests/ (this analyses the code, and might rise issues that need to be fixed before the pull request) mypy --ignore-missing-imports src/ tests/ (this is a static checker, and might rise issues that need to be fixed before the pull request) pytest --cov=expreccs --cov-report term-missing tests/ (this runs locally the tests, and might rise issues that need to be fixed before the pull request) Tip See the CI.yml script and the Actions for installation of expreccs, OPM Flow (binary packages), and dependencies, as well as the execution of the six previous steps in Ubuntu 24.04 using Python 3.11.
+ See the CI.yml script and the Actions for installation of expreccs, OPM Flow (binary packages), and dependencies, as well as the execution of the six previous steps in Ubuntu 24.04 using Python 3.12.
For macOS users, see the ci_pycopm_macos.yml script and the OPM-Flow_macOS Actions for installation of pycopm (a related tool to expreccs), OPM Flow (source build), and dependencies in macOS 26 using Python 3.13.
In addition for macOS, you need to add the directory containing the OPM Flow executable to your system’s PATH environment variable (e.g., export PATH=$PATH:/Users/yourname/pyopmspe11/build/opm-simulators/bin). Tip See the CI.yml script
-for installation of OPM Flow (binary packages), LaTeX (optional) libraries, and the expreccs package in Ubuntu 24.04 and Python 3.11.Contribute to the software
Contribute to the software
Binary packages
If you are a Linux user (including the Windows subsystem for Linux, see this link for a nice tutorial for setting Python environments in WSL), then you could try to build Flow (after installing the prerequisites) from the master branches with mpi support by running -in the terminal the following lines (which in turn should build flow in the folder ./build/opm-simulators/bin/flow.):
+in the terminal the following lines (which in turn should build flow in the folder ./build/opm-simulators/bin/flow):CURRENT_DIRECTORY="$PWD"
mkdir build
@@ -172,7 +172,7 @@ Source build in Linux/Windowsdo git clone https://github.com/OPM/opm-$repo.git
mkdir build/opm-$repo
cd build/opm-$repo
- cmake -DUSE_MPI=1 -DWITH_NDEBUG=1 -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH="$CURRENT_DIRECTORY/build/opm-common;$CURRENT_DIRECTORY/build/opm-grid" $CURRENT_DIRECTORY/opm-$repo
+ cmake -DUSE_MPI=1 -DWITH_NDEBUG=1 -DCMAKE_BUILD_TYPE=Release $CURRENT_DIRECTORY/opm-$repo
if [[ $repo == simulators ]]; then
make -j5 flow
else
@@ -191,7 +191,7 @@ Source build in Linux/WindowsBrew formula for macOS
For macOS, there are no available binary packages, so OPM Flow needs to be built from source. Recently, a formula to build flow using brew has
been added in https://github.com/cssr-tools/homebrew-opm.
-Then, you can try to install flow (v2025.10) by simply typing:
+Then, you can try to install flow (v2026.02) by simply typing:
brew install cssr-tools/opm/opm-simulators
@@ -203,46 +203,7 @@ Source build in Linux/Windows
Source build in macOS
-If you would like to build the latest OPM Flow from the master branch, then you can first install the prerequisites using brew:
-brew install cjson boost openblas suite-sparse python@3.14 cmake
-
-
-In addition, it is recommended to uprade and update your macOS to the latest available versions (the following steps have
-worked for macOS Tahoe 26.2.0 with Apple clang version 17.0.0).
-After the prerequisites are installed, then building OPM Flow can be achieved with the following bash lines:
-CURRENT_DIRECTORY="$PWD"
-
-for module in common geometry grid istl
-do git clone https://gitlab.dune-project.org/core/dune-$module.git
- cd dune-$module && git checkout v2.10.0 && cd ..
- ./dune-common/bin/dunecontrol --only=dune-$module cmake -DCMAKE_DISABLE_FIND_PACKAGE_MPI=1
- ./dune-common/bin/dunecontrol --only=dune-$module make -j5
-done
-
-mkdir build
-
-for repo in common grid simulators
-do git clone https://github.com/OPM/opm-$repo.git
- mkdir build/opm-$repo && cd build/opm-$repo
- cmake -DUSE_MPI=0 -DWITH_NDEBUG=1 -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH="$CURRENT_DIRECTORY/dune-common/build-cmake;$CURRENT_DIRECTORY/dune-grid/build-cmake;$CURRENT_DIRECTORY/dune-geometry/build-cmake;$CURRENT_DIRECTORY/dune-istl/build-cmake;$CURRENT_DIRECTORY/build/opm-common;$CURRENT_DIRECTORY/build/opm-grid" $CURRENT_DIRECTORY/opm-$repo
- if [[ $repo == simulators ]]; then
- make -j5 flow
- else
- make -j5 opm$repo
- fi
- cd ../..
-done
-
-echo "export PATH=\$PATH:$CURRENT_DIRECTORY/build/opm-simulators/bin" >> ~/.zprofile
-source ~/.zprofile
-
-
-This builds OPM Flow, and it exports the path to the flow executable. You can check if the installation of OPM Flow succeded by typing in the terminal flow --help.
-
-Tip
-See this repository dedicated to build OPM Flow from source in the latest macOS (GitHub actions).
-If you still face problems, raise an issue in the GitHub repository, or you could also send an email to the maintainers.
-
+See this repository dedicated to build OPM Flow from source in the latest macOS (GitHub actions), and tested with pycopm, another repository in cssr-tools.
diff --git a/docs/searchindex.js b/docs/searchindex.js
index 6568dc2..fff422f 100644
--- a/docs/searchindex.js
+++ b/docs/searchindex.js
@@ -1 +1 @@
-Search.setIndex({"alltitles":{"About expreccs":[[0,null]],"Binary packages":[[21,"binary-packages"]],"Brew formula for macOS":[[21,"brew-formula-for-macos"]],"Concept":[[22,"concept"]],"Configuration file":[[2,null]],"Contribute to the software":[[3,"contribute-to-the-software"]],"Contributing":[[3,null]],"Examples":[[4,null]],"Ground Rules":[[3,"ground-rules"]],"Hello world":[[4,"hello-world"]],"Indices and tables":[[20,"indices-and-tables"]],"Installation":[[21,null]],"Introduction":[[22,null]],"Layered model":[[4,"layered-model"]],"Module contents":[[5,"module-expreccs"],[6,"module-expreccs.core"],[8,"module-expreccs.utils"],[16,"module-expreccs.visualization"]],"Non-regular boundaries":[[4,"non-regular-boundaries"]],"OPM Flow":[[21,"opm-flow"]],"Output folder":[[24,null]],"Overview":[[22,"overview"]],"Python package":[[21,"python-package"]],"Regular boundaries":[[4,"regular-boundaries"]],"Related":[[25,null]],"Reporting issues or problems":[[3,"reporting-issues-or-problems"]],"Reservoir-related parameters":[[2,"reservoir-related-parameters"]],"Rock-related parameters":[[2,"rock-related-parameters"]],"Seek support":[[3,"seek-support"]],"Simulation results":[[2,"simulation-results"]],"Source build in Linux/Windows":[[21,"source-build-in-linux-windows"]],"Source build in macOS":[[21,"source-build-in-macos"]],"Submodules":[[6,"submodules"],[8,"submodules"],[16,"submodules"]],"Subpackages":[[5,"subpackages"]],"TCCS-13":[[26,null]],"Via OPM Flow decks":[[4,"via-opm-flow-decks"],[24,"via-opm-flow-decks"]],"Via configuration files":[[4,"via-configuration-files"],[24,"via-configuration-files"]],"Welcome to the expreccs\u2019s documentation!":[[20,null]],"Well-related parameters":[[2,"well-related-parameters"]],"ad-micp":[[25,"ad-micp"]],"expreccs":[[1,"expreccs"],[23,null]],"expreccs Python API":[[1,null]],"expreccs package":[[5,null]],"expreccs.core package":[[6,null]],"expreccs.core.expreccs module":[[7,null]],"expreccs.utils package":[[8,null]],"expreccs.utils.backcoupling module":[[9,null]],"expreccs.utils.inputvalues module":[[10,null]],"expreccs.utils.mapboundaries module":[[11,null]],"expreccs.utils.mapproperties module":[[12,null]],"expreccs.utils.reg_sit_given_decks module":[[13,null]],"expreccs.utils.runs module":[[14,null]],"expreccs.utils.writefile module":[[15,null]],"expreccs.visualization package":[[16,null]],"expreccs.visualization.maps2d module":[[17,null]],"expreccs.visualization.plotting module":[[18,null]],"expreccs.visualization.reading module":[[19,null]],"plopm":[[25,"plopm"]],"pofff":[[25,"pofff"]],"pycopm":[[25,"pycopm"]],"pymm":[[25,"pymm"]],"pyopmnearwell":[[25,"pyopmnearwell"]],"pyopmspe11":[[25,"pyopmspe11"]]},"docnames":["about","api","configuration_file","contributing","examples","expreccs","expreccs.core","expreccs.core.expreccs","expreccs.utils","expreccs.utils.backcoupling","expreccs.utils.inputvalues","expreccs.utils.mapboundaries","expreccs.utils.mapproperties","expreccs.utils.reg_sit_given_decks","expreccs.utils.runs","expreccs.utils.writefile","expreccs.visualization","expreccs.visualization.maps2d","expreccs.visualization.plotting","expreccs.visualization.reading","index","installation","introduction","modules","output_folder","related","tccs-13"],"envversion":{"sphinx":65,"sphinx.domains.c":3,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":9,"sphinx.domains.index":1,"sphinx.domains.javascript":3,"sphinx.domains.math":2,"sphinx.domains.python":4,"sphinx.domains.rst":2,"sphinx.domains.std":2},"filenames":["about.rst","api.rst","configuration_file.rst","contributing.rst","examples.rst","expreccs.rst","expreccs.core.rst","expreccs.core.expreccs.rst","expreccs.utils.rst","expreccs.utils.backcoupling.rst","expreccs.utils.inputvalues.rst","expreccs.utils.mapboundaries.rst","expreccs.utils.mapproperties.rst","expreccs.utils.reg_sit_given_decks.rst","expreccs.utils.runs.rst","expreccs.utils.writefile.rst","expreccs.visualization.rst","expreccs.visualization.maps2d.rst","expreccs.visualization.plotting.rst","expreccs.visualization.reading.rst","index.rst","installation.rst","introduction.rst","modules.rst","output_folder.rst","related.rst","tccs-13.rst"],"indexentries":{},"objects":{"":[[5,0,0,"-","expreccs"]],"expreccs":[[6,0,0,"-","core"],[8,0,0,"-","utils"],[16,0,0,"-","visualization"]],"expreccs.core":[[7,0,0,"-","expreccs"]],"expreccs.core.expreccs":[[7,1,1,"","check_cmdargs"],[7,1,1,"","expreccs"],[7,1,1,"","load_parser"],[7,1,1,"","main"]],"expreccs.utils":[[9,0,0,"-","backcoupling"],[10,0,0,"-","inputvalues"],[11,0,0,"-","mapboundaries"],[12,0,0,"-","mapproperties"],[13,0,0,"-","reg_sit_given_decks"],[14,0,0,"-","runs"],[15,0,0,"-","writefile"]],"expreccs.utils.backcoupling":[[9,1,1,"","backcoupling"],[9,1,1,"","compute_multipliers"],[9,1,1,"","init_multipliers"],[9,1,1,"","write_folder_iter"]],"expreccs.utils.inputvalues":[[10,1,1,"","check_entries"],[10,1,1,"","process_input"],[10,1,1,"","process_tuning"]],"expreccs.utils.mapboundaries":[[11,1,1,"","aquaflux"],[11,1,1,"","handle_pressure_correction"],[11,1,1,"","handle_stencil"],[11,1,1,"","handle_stencil_2p"],[11,1,1,"","porv_projections"],[11,1,1,"","porv_regional_segmentation"],[11,1,1,"","temporal_interpolation_flux"],[11,1,1,"","temporal_interpolation_pressure"]],"expreccs.utils.mapproperties":[[12,1,1,"","mapping_properties"],[12,1,1,"","positions_reference"],[12,1,1,"","positions_regional"],[12,1,1,"","positions_rotation"],[12,1,1,"","positions_site"],[12,1,1,"","rotate_grid"]],"expreccs.utils.reg_sit_given_decks":[[13,1,1,"","check_intersection"],[13,1,1,"","check_regional_neighbours"],[13,1,1,"","create_deck"],[13,1,1,"","dynamic_interpolator"],[13,1,1,"","extract_site_borders"],[13,1,1,"","find_ij_orientation"],[13,1,1,"","find_regional_cells"],[13,1,1,"","get_bccon"],[13,1,1,"","get_xymaps"],[13,1,1,"","handle_grid_coord"],[13,1,1,"","project_pressures"],[13,1,1,"","site_contour"],[13,1,1,"","temporal_interpolation"],[13,1,1,"","write_files"]],"expreccs.utils.runs":[[14,1,1,"","plotting"],[14,1,1,"","run_models"],[14,1,1,"","simulations"]],"expreccs.utils.writefile":[[15,1,1,"","compact_format"],[15,1,1,"","write_files"],[15,1,1,"","write_folders"],[15,1,1,"","write_grid"],[15,1,1,"","write_properties"]],"expreccs.visualization":[[17,0,0,"-","maps2d"],[18,0,0,"-","plotting"],[19,0,0,"-","reading"]],"expreccs.visualization.maps2d":[[17,1,1,"","final_time_maps"],[17,1,1,"","final_time_maps_difference"],[17,1,1,"","geological_maps"],[17,1,1,"","manage_name"]],"expreccs.visualization.plotting":[[18,1,1,"","handle_labels_difference"],[18,1,1,"","handle_labels_distance"],[18,1,1,"","handle_site_summary"],[18,1,1,"","over_time_distance"],[18,1,1,"","over_time_max_difference"],[18,1,1,"","over_time_sensor"],[18,1,1,"","plot_results"],[18,1,1,"","plotting_settings"],[18,1,1,"","positions"],[18,1,1,"","summary_plot"],[18,1,1,"","summary_site"],[18,1,1,"","wells_site"]],"expreccs.visualization.reading":[[19,1,1,"","define_cases"],[19,1,1,"","make_arrays"],[19,1,1,"","manage_names"],[19,1,1,"","reading_simulations"]]},"objnames":{"0":["py","module","Python module"],"1":["py","function","Python function"]},"objtypes":{"0":"py:module","1":"py:function"},"terms":{"":[2,3,4,21,22,24,26],"0":[2,4,15,21,22,24,26],"001":26,"00e":2,"01":2,"01013":2,"02":[4,26],"04":[3,21],"05e3":4,"0f":[4,26],"0pressur":26,"1":[2,4,21,22,26],"10":[2,21,26],"1000":2,"10000":2,"101":2,"1013":2,"10132":2,"10e3":4,"11":[3,21,26],"11000":2,"111":26,"112":26,"11377":2,"11423e":2,"116":26,"117":26,"11th":2,"12":[2,4,26],"126":26,"13":[3,20],"13140":26,"1324":2,"14":[2,21,26],"14518":2,"15":2,"15000":[2,4],"15e3":4,"16":[4,26],"160000":26,"17":21,"18000":2,"193531e":2,"199":4,"1d":18,"1e":[2,26],"1e0":26,"1e1":2,"1e2":2,"1e3":2,"1e4":2,"1e5":2,"1e6":2,"1e7":2,"1e8":2,"1f":[4,26],"2":[2,4,21,22,26],"20":[2,4],"20000":2,"202":2,"2025":[21,26],"203":26,"21180":2,"21583":2,"217":26,"21718":2,"22":2,"24":[3,4,21,26],"24081":2,"24200":2,"24886":26,"24e3":4,"25":[2,4,26],"26":[3,21],"2650":2,"27000":2,"2732":2,"28477":2,"2d":[17,18],"2e2":2,"2f":26,"3":[2,3,4,21,22,26],"30":[2,4,26],"3060":2,"3060e":2,"31":26,"31679":2,"319":4,"32":2,"324":2,"325":2,"336294":0,"33e3":4,"34":2,"365":2,"3870":2,"3b":26,"3e5":2,"4":[2,26],"41283":26,"417":4,"45":2,"450":26,"45000":2,"47":2,"48":26,"495000":26,"5":[2,4,26],"50":2,"500":4,"5000":2,"506":2,"50e3":4,"525":26,"55":2,"55e3":4,"56":26,"57":26,"5710":2,"5e6":2,"6":[2,4,26],"60":[2,26],"605e6":26,"60e3":4,"6120":2,"625":2,"63e":2,"65":[2,26],"650":2,"6625":2,"7":[2,22,26],"7068":2,"7122":2,"73":2,"7800":2,"8":[2,4,26],"80":26,"8000":2,"809":26,"80e3":4,"81":2,"8233":2,"8654":2,"8883":2,"9":[2,26],"92":2,"95":[4,26],"95000":26,"99e":2,"A":[9,25,26],"For":[0,2,3,4,21,26],"If":[2,4,21],"In":[2,3,4,21,22,24],"The":[0,1,2,3,4,21,22,24,26],"Then":[2,4,21,24,26],"There":21,"To":[2,4,21,26],"_":[9,26],"_build":3,"_of_input_fil":22,"abl":21,"about":[3,20],"abov":[2,26],"accept":3,"achiev":[2,4,21],"action":[3,21],"activ":[2,13,21,26],"actual":26,"ad":[2,9,10,20,21,22,26],"adapt":26,"add":[2,3,4,13,24],"addit":[1,2,3,4,21,24],"after":[4,12,21,24,26],"all":[2,3,4,21,22,26],"allow":[2,26],"along":[2,4,22],"also":[2,3,4,21,24],"altern":3,"an":[0,2,3,4,21,22,25],"anaconda":21,"analys":3,"ani":[2,3,4],"anim":4,"anoth":4,"answer":3,"api":20,"appl":21,"appli":4,"applic":4,"approach":[0,2,3,4,22,26],"apt":21,"aquaflux":[5,8,11],"aquif":[2,26],"ar":[0,2,3,4,9,13,21,22,24,25,26],"arg":[7,9,10,11,12,13,14,15,17,18,19],"argument":[2,7,22],"arrai":[2,13,19,22],"assess":2,"avail":[2,21],"averag":26,"avoid":2,"b":[22,26],"back":[9,19],"backcoupl":[5,8],"bar":[2,26],"base":[4,9,22,25],"bash":21,"bc":[2,4,11,13,15,22,24],"bccon":24,"becom":22,"been":21,"befor":[3,26],"below":[4,25],"benchmark":25,"better":18,"between":[1,4,17,18,22],"bfebf2":26,"bhp":[2,4,18],"bin":[2,3,21],"binari":[3,13,20],"black":[3,26],"bool":19,"boost":21,"border":[13,18],"both":2,"bottom":[2,4],"boundari":[2,11,13,20,22,24],"box":2,"branch":21,"brew":20,"brg":26,"build":[2,3,4,13,20],"build_opm_mpi":21,"built":21,"c":[2,4,22,26],"calcit":25,"call":[4,24],"can":[2,3,4,21,24,26],"capabl":2,"capillari":2,"cardin":13,"carlson":2,"case":[4,15,19],"cbsfax":[4,26],"cd":21,"cell":[2,4,11,13,18,22,24,26],"cet_diverging_rainbow_bgymr_45_85_c67":26,"cfd":25,"cformat":[4,26],"chang":[2,3,4],"check":[7,10,13,21,25],"check_cmdarg":[5,6,7],"check_entri":[5,8,10],"check_intersect":[5,8,13],"check_regional_neighbour":[5,8,13],"checker":3,"checkout":21,"chosen":2,"ci":[3,21],"ci_pycopm_maco":3,"clabel":26,"clang":21,"clone":21,"close":2,"closest":[2,13,18],"cm":21,"cmake":21,"cmdarg":7,"cnum":26,"cnv":26,"co2":[2,4,22,25],"coarsen":26,"coarsened_improv":26,"coarsened_perm":26,"coarsened_tran":26,"coarser":2,"code":[3,5,21],"coeffici":22,"collabor":3,"color":18,"com":[4,21,22,26],"combin":7,"command":[2,4,7,21,26],"commit":3,"common":[21,26],"compact":15,"compact_format":[5,8,15],"compar":[2,4,22,24],"comparison":[1,4],"compens":9,"complet":[17,19],"complex":4,"compress":2,"comput":[2,9],"compute_multipli":[5,8,9],"concept":20,"condit":[2,4,22,24],"config":4,"configur":[1,10,20,22],"conform":22,"connect":[13,22,24],"conrour":13,"consid":[2,4],"contact":26,"contain":[1,3],"content":[1,3,20,23],"continu":2,"contour":[13,22],"contribut":[0,20,21],"control":[2,26],"cook":26,"coord":13,"coordin":[2,13,18],"copi":[3,21],"core":[1,5,21,23,26],"corner":[2,15,22],"correct":11,"correspond":[1,2,4,22,24],"could":[21,24,26],"council":0,"count":13,"counter":11,"coupl":[9,19],"cov":[3,4],"cp":2,"cpg":[2,22],"cpr_trueimp":26,"creat":[3,4,13,21,22,24],"create_deck":[5,8,13],"csp":[2,25],"cssr":[4,21,22,26],"curiou":4,"current":[9,18,21,22,26],"current_directori":21,"curv":2,"d":[2,4,26],"d_z":13,"dai":[2,4],"data":[4,19,26],"dcmake_build_typ":21,"dcmake_disable_find_package_mpi":21,"dcmake_prefix_path":21,"de":24,"deactiv":2,"deck":[1,2,13,14,18,19,20,22,26],"dedic":21,"default":[2,22],"defin":[2,4,22],"define_cas":[5,16,19],"definit":[2,24],"delax":[4,26],"demonstr":4,"depend":[3,21,26],"depth":[2,26],"describ":[2,3,22,26],"desir":2,"detail":0,"dev":[3,21],"develop":[21,22],"dic":[9,10,11,12,13,14,15,17,18,19],"dict":[7,9,10,11,12,13,14,15,17,18,19],"dictionari":[9,10,11,12,13,14,15,17,18,19],"differ":[1,2,4,9,11,12,17,18,22,24],"dimens":[2,26],"dir":[2,11,13],"dire":13,"direct":[2,4,13],"directli":24,"director":26,"directori":[3,22],"discret":[2,22],"distanc":[4,18],"dmar":2,"do":[4,21,22],"doc":3,"document":[2,3,21,22,24],"doe":4,"doi":26,"done":[9,21],"doplot":19,"download":21,"dune":21,"dunecontrol":21,"duse_mpi":21,"dvipng":21,"dwith_ndebug":21,"dynam":[2,4,22,24,25],"dynamic_interpol":[5,8,13],"e":[2,3,4,21,22,24,26],"each":[2,22],"echo":21,"edg":21,"ehystr":2,"either":21,"els":21,"em":25,"email":[3,21],"enabl":[2,26],"end":[2,4,26],"energi":0,"enter":2,"enterpris":21,"entri":[2,10,22],"environ":[3,21],"equal":[4,22],"equidist":22,"equinor":0,"error":2,"ert":26,"evalu":[2,22],"everest":26,"exampl":[2,20,24],"example1":[2,4],"example1_porvproj":4,"example1_pr":4,"example1_wel":[2,4],"example2":4,"except":2,"execut":[1,2,3,4,7,21,22,24,26],"exisit":26,"exist":21,"exmapl":2,"explain":4,"explicit":22,"expon":2,"exponenti":22,"export":[3,21],"exprecc":[2,3,4,21,22,24,26],"expreccs_dpincreas":4,"expreccs_perfipnum":4,"expreccss":1,"extend":[2,3],"extra":21,"extract":[4,18],"extract_site_bord":[5,8,13],"f":[4,22,26],"face":[11,21],"fals":19,"familiar":3,"fault":[2,12,22,26],"fault_region":2,"fault_sit":2,"featur":[0,26],"few":26,"fi":21,"fig":26,"fig1":26,"fig10a":26,"fig10bc":26,"fig12a":26,"fig2":26,"fig3b":26,"fig5":26,"fig6a":26,"fig6b":26,"fig8low":26,"fig8upp":26,"fig9":26,"figur":[4,14,17,19,21,22,26],"fil":9,"file":[1,3,10,13,15,19,20,21,22,26],"final":[2,4,26],"final_time_map":[5,16,17],"final_time_maps_differ":[5,16,17],"find":[12,13],"find_ij_orient":[5,8,13],"find_regional_cel":[5,8,13],"fipnum":[4,13,22],"fipr":13,"first":[2,19,21,26],"five":2,"fix":3,"flag":[2,4,7,22,24],"flexibl":22,"float":13,"flow":[2,3,14,15,19,20,25,26],"flow_maco":3,"fluid":2,"fluidflow":25,"flux":[2,4,9,11],"flux_region":9,"flux_sit":9,"focus":22,"fol":[18,19],"folder":[1,2,3,4,9,15,17,18,19,20,21,22,26],"follow":[2,4,21,22,24,26],"font":21,"fork":[0,3],"format":[3,21],"former":4,"formula":20,"fot":13,"fraction":[2,26],"framework":[2,22,25],"frequenc":22,"friend":4,"from":[2,3,4,9,10,11,13,18,19,21,22,25,26],"full":2,"function":[2,4,7,9,10,11,12,13,14,15],"fund":0,"further":[2,4],"g":[2,3,4,21,22,24],"ga":[2,4],"gasda":26,"gener":[1,2,3,4,14,22,24,25,26],"geolog":[1,2,4,9,14,15,22,25],"geological_map":[5,16,17],"geometri":21,"get":[3,13,21,26],"get_bccon":[5,8,13],"get_xymap":[5,8,13],"gif":25,"gind":13,"git":[4,21,26],"github":[3,4,21,22,26],"gitlab":21,"give":2,"given":[1,2,4,9,13,22,24],"global":[9,10,11,12,13,14,15,17,18,19,26],"gnuplot2":26,"grade":22,"grid":[2,4,12,13,15,21,22,26],"ground":20,"group":2,"h":[2,26],"ha":[2,21,26],"hand":13,"handl":[12,22],"handle_grid_coord":[5,8,13],"handle_labels_differ":[5,16,18],"handle_labels_dist":[5,16,18],"handle_pressure_correct":[5,8,11],"handle_site_summari":[5,16,18],"handle_stencil":[5,8,11],"handle_stencil_2p":[5,8,11],"handli":22,"harbour":0,"hat":21,"have":21,"height":2,"hello":[20,24],"hello_world":4,"hello_world_distance_from_bord":4,"hello_world_reference_watfluxi":4,"hello_world_regional_watfluxi":4,"hello_world_sensor_pressure_over_tim":4,"hello_world_site_flux_watfluxi":4,"hello_world_summary_bhp_site_refer":4,"help":[2,3,21],"here":[0,2,4,24,26],"heterogein":[2,22],"heterogen":4,"higher":2,"histori":25,"home":4,"homebrew":21,"homogen":26,"horizont":13,"host":22,"how":[4,26],"html":3,"http":[4,21,22,26],"hydrosta":13,"hysteresi":[2,22],"hystopt":2,"i":[0,1,2,3,4,9,11,13,18,21,22,24,26],"identifi":22,"ignor":3,"ij":4,"imag":[1,25],"imbibit":2,"imbnum":26,"implement":[2,22],"import":3,"improv":[18,22,26],"in_fil":10,"inact":[4,22],"inc":[4,24],"includ":[1,4,21,22],"increas":[4,22,26],"ind":13,"index":[13,18,20],"indic":[13,18],"induc":25,"init_multipli":[5,8,9],"initi":[2,9,13],"inj":2,"inject":[2,18],"injector":[2,4],"input":[1,2,4,9,10,14,22],"inputvalu":[5,8],"insid":[2,4,21],"instal":[3,4,20,26],"instead":2,"instruct":21,"int":[9,11,13,18],"integr":2,"interest":[2,21,25],"interp":2,"interpol":[2,4,11,13,24],"introduct":[4,20],"invalid":7,"irregular":22,"issu":[0,20,21],"istl":21,"iter":[2,9,11,15,26],"iterativli":9,"j":[18,22],"j5":21,"johansen":26,"jump":2,"kept":2,"keyword":2,"kg":2,"killough":2,"km":[4,26],"kr":2,"krn":2,"krw":2,"kxy":2,"kz":2,"l":[4,21,22,26],"label":[4,18,24],"landa":26,"last":[17,19],"later":4,"latest":21,"latex":21,"layer":[2,20,22],"leakag":25,"left":[2,4,13],"length":2,"librari":21,"like":21,"lim":26,"limipr":26,"limit":[2,26],"line":[2,3,4,13,18,21],"linear":[2,26],"link":[0,21],"lint":21,"linux":20,"list":[13,15,18,19],"literatur":26,"load_pars":[5,6,7],"local":3,"locat":[1,2,4,11,12,18,22,26],"log":26,"look":[3,26],"lot":26,"lower":2,"m":[2,4,21,22,26],"machin":[2,21],"maco":[3,20],"macport":21,"mactex":21,"main":[1,3,5,6,7],"maintain":[3,21],"make":[3,15,21],"make_arrai":[5,16,19],"mako":[1,15],"mamba":21,"manag":[18,21],"manage_nam":[5,16,17,19],"managua_r":26,"mani":2,"mantain":3,"manual":2,"manuscript":4,"map":[4,11,12,13,17,18,22],"mapboundari":[5,8],"mapp":4,"mapping_properti":[5,8,12],"mapproperti":[5,8],"maps2d":[5,16],"marb\u00e1n":26,"mark":22,"master":21,"match":[25,26],"max":[2,18,26],"maximum":[2,26],"md":2,"merg":3,"metric":22,"micp":20,"microbi":25,"microsystem":25,"middel":4,"middl":[2,4],"might":[3,21,25,26],"min":[2,26],"miniforg":21,"minimum":4,"miss":[3,4],"mkdir":21,"model":[1,2,9,13,14,15,17,19,20,22,24,25,26],"modif":22,"modifi":[9,10,11,12,13,14,15,17,18,19,21,24],"modul":[1,20,21,23,25],"more":[0,3,4],"mpi":21,"mpirun":[2,26],"mt":2,"mult":9,"multipli":[2,9],"mypi":3,"n":[2,4,13,15,22],"name":[2,4,9,10,14,15,17,18,19,22],"ndeck":18,"necessari":[4,15],"need":[3,21,22,26],"neighbour":13,"new":[0,3,4,10],"newton":[2,26],"newtoniterationcount":26,"nfol":18,"nice":[3,21,22],"nkrn":2,"nkrw":2,"nnc":13,"non":[2,20],"none":[7,9,10,14,15,17,18,22],"norwai":0,"norwegian":26,"notat":15,"now":[2,4],"np":[2,26],"npen":2,"npoint":2,"nqua":18,"nquan":18,"nrst":18,"num":2,"number":[0,2,9,13,18,22,26],"numpi":15,"nwell":18,"nx":22,"ny":22,"o":[4,22,24],"observ":2,"offset":[4,13,22],"offshor":26,"one":[2,4,24],"ones":26,"onli":[2,4,19,21,22],"onlin":21,"open":[2,21,25],"openbla":21,"oper":[2,22],"opernum":[4,24],"opernum_exprecc":[4,24],"opm":[1,2,3,14,15,18,19,20,25,26],"opmn":18,"optim":[4,26],"optimal_solut":26,"option":[2,7,21,22],"order":2,"org":[21,26],"orginin":26,"origen":2,"origin":26,"other":21,"our":[3,4],"out":[17,19,25],"output":[2,15,18,19,20,22],"over":[2,13],"over_time_dist":[5,16,18],"over_time_max_differ":[5,16,18],"over_time_sensor":[5,16,18],"overlap":[4,13,24],"overpr":26,"overpressur":26,"overview":[2,20],"own":3,"p":[4,13,22,26],"packag":[1,3,4,20,23],"page":[3,4,20],"paper":26,"paper_2025":4,"parallel":26,"paramet":[10,20],"part":4,"partit":22,"path":[2,3,21,22],"path_to_the_regional_model":4,"path_to_the_site_model":4,"pc":2,"pcap":2,"pen":2,"per":[2,4,22],"period":2,"perm":[2,26],"permeabl":26,"phi":2,"pi":2,"pip":[3,4,21,26],"platform":21,"pleas":[0,3],"plopm":[4,20,21,24,26],"plot":[5,8,14,15,16,17,19,22,24],"plot_result":[5,16,18],"plotting_set":[5,16,18],"plume":4,"png":[1,4,25],"pofff":20,"point":[2,15,18,22],"pore":[2,4,11,26],"poro":26,"porv":[2,26],"porv_project":[5,8,11],"porv_regional_segment":[5,8,11],"porvproj":[2,4],"posit":[2,5,12,13,16,18],"positions_refer":[5,8,12],"positions_region":[5,8,12],"positions_rot":[5,8,12],"positions_sit":[5,8,12],"possibl":[2,3],"postprocess":[4,22,24,26],"powerpoint":26,"pr":3,"practic":2,"pre":[2,4,11],"precipit":25,"prefer":3,"prefix":15,"preprocess":[10,22,24],"prerequisit":21,"pres2p":2,"prescrib":4,"pressur":[1,2,4,11,13,18,22,24,26],"presur":2,"previou":[3,4,21],"problem":[20,21],"proce":[2,4],"proceed":26,"process":[1,10,13],"process_input":[5,8,10],"process_tun":[5,8,10],"prod":2,"produc":[2,4],"project":[0,1,2,4,11,13,18,21,22,25],"project_pressur":[5,8,13],"prompt":26,"properti":[2,22,26],"pull":[0,3],"push":3,"pushd":3,"pv":[2,11,26],"pwd":21,"py":[4,24,26],"pycopm":[2,3,4,20,26],"pylint":3,"pymm":20,"pyopmnearwel":20,"pyopmspe11":[3,20],"pytest":[3,4],"python":[3,20,25,26],"python3":[21,26],"quantiti":[12,17,18,19],"quick":25,"quotat":22,"r":[2,3,4,21,26],"rais":[0,3,21],"rate":[2,18],"re":[17,18,19],"read":[5,11,16],"reading_simul":[5,16,19],"recent":21,"recommend":21,"record":2,"rectangl":[4,22],"red":21,"refer":[1,2,4,12,14,15,17,18,22,24],"reference_x_n":2,"reference_y_n":2,"reference_z_n":2,"refin":[2,4,11],"reg":[11,13],"reg_sit_given_deck":[5,8],"regard":[2,4],"region":[1,2,4,9,11,13,14,18,22,24],"regional_bctyp":2,"regional_dim":2,"regional_sit":22,"regional_x_n":2,"regional_y_n":2,"regional_z_n":2,"regul":4,"regular":20,"rel":2,"relat":[3,15,20,24],"relax":[2,26],"releas":21,"remedi":25,"remov":26,"repit":15,"replac":3,"repo":[3,21],"report":[4,13,20,22],"repositori":[3,21],"reproduc":26,"request":[0,3],"requier":[4,12],"requir":[2,3,10,21],"requiri":10,"rerun":4,"research":0,"reservoir":[4,12,15,17,18,20],"residu":2,"resinsight":[2,4,21,24,26],"resourc":26,"respect":[2,4],"rest":26,"restart":[2,13],"result":[4,20,21,24,26],"return":[7,9,10,11,12,13,14,15,17,18,19],"review":3,"rg":26,"right":[2,13],"rise":3,"rock":[20,22],"rock_comp":2,"rotat":[4,12,22],"rotate_grid":[5,8,12],"routin":[1,15,18],"row":2,"rpr":4,"rst":[2,26],"rule":20,"run":[1,2,3,4,5,8,15,21,22,24,26],"run_model":[5,8,14],"safu":2,"salin":2,"same":[2,4,26],"sand":2,"sandv":26,"sandwich":4,"sat":2,"satur":[2,4,18],"save":[4,15,24,26],"schedul":[2,4,11,18,22],"screenshot":[2,24],"script":[1,3,7,11,13,17,18,19,21],"search":20,"second":2,"section":[2,4,22],"see":[2,3,4,21,22,24],"seek":20,"select":[4,24],"send":[3,21],"sensor":[2,4,18,26],"sensor_coord":2,"set":[2,4,10,12,18,21,22,26],"set1_r":4,"setuptool":21,"sga":4,"sh":21,"share":2,"shell":0,"should":[21,26],"show":[1,2,4,24],"shut":2,"side":[2,11,13,22],"similar":26,"similarli":2,"simillarli":2,"simpl":4,"simpler":2,"simpli":21,"simplic":4,"simplifi":22,"simul":[1,3,4,5,8,14,17,19,20,21,22,24,25],"sin":2,"sinc":[2,26],"singl":3,"sintef":26,"site":[1,2,4,9,11,12,13,14,17,18,22,24],"site_bctyp":2,"site_clos":[4,24],"site_contour":[5,8,13],"site_loc":2,"six":[2,3],"size":[2,4],"skip":[21,22,26],"sni":2,"so":21,"softwar":20,"solut":2,"solver":[24,26],"some":[4,15,24,25],"soon":3,"sourc":[3,20,25],"space":22,"spars":21,"spatial":13,"spe":2,"spe11":25,"specif":21,"speed":2,"squash":3,"src":3,"stage":[4,22],"start":[4,13],"statfjord":26,"static":[3,4],"step":[2,3,13,17,21,22,26],"still":21,"storag":[15,22],"str":[9,10,13,14,15,17,18,19],"string":2,"studi":[2,4,14,25,26],"style":18,"subfig":[4,26],"subfold":[22,24],"submit":26,"submodel":4,"submodul":[1,5,23],"subpackag":[1,20,23],"subsystem":21,"succe":3,"succed":21,"sudo":21,"suit":21,"summari":18,"summary_plot":[5,16,18],"summary_sit":[5,16,18],"super":21,"support":[2,20,21,22,26],"suptitl":[4,26],"surfac":[2,17,18],"sw":2,"swi":2,"system":[2,3],"t":[2,22,26],"tag":21,"taho":21,"tailor":25,"take":26,"tcc":20,"telescop":22,"temperatur":2,"templat":15,"temporal_interpol":[5,8,13],"temporal_interpolation_flux":[5,8,11],"temporal_interpolation_pressur":[5,8,11],"term":[3,4],"termin":[4,21],"test":[3,4,21,22],"test_2_generic_deck":4,"test_4_site_region":4,"test_generic_deck":24,"texliv":21,"than":[0,3],"thei":4,"them":[0,2,22],"thi":[2,3,4,9,21,22,24,26],"thick":[2,13],"those":26,"three":[2,4],"threshold":2,"through":21,"time":[2,11,13,17,22,26],"timestep":22,"toler":26,"toml":[2,4,10,22],"tool":[0,3,4,21,22,25,26],"top":[2,4,17,18],"total":26,"tracer":24,"tran":[2,26],"translat":26,"transmiss":26,"troll":26,"true":[2,19,26],"try":[3,21],"tsmaxz":2,"tug":21,"tune":[2,10],"turn":21,"tutori":[3,21],"two":[2,4,19,22],"txt":[3,21],"type":[4,21,25],"u":22,"ubuntu":[3,21],"until":2,"up":2,"updat":[9,21,22],"upgrad":21,"upper":2,"uprad":21,"us":[0,2,3,4,9,15,18,19,21,22,24,25,26],"user":[2,3,21],"util":[1,5,23],"utilii":[9,10,11,12,13,14,15],"v":[4,26],"v2":21,"v2025":21,"valid":22,"valu":[2,4,10,11,13,15,22,26],"variabl":[2,3,4,15],"veloc":4,"venv":21,"version":[5,21,26],"vertic":13,"vexprecc":21,"via":[2,20,21,26],"virtual":21,"visit":3,"visual":[1,2,4,5,21,23,24],"volum":[2,4,11,26],"vtk":25,"w":[2,4,22,26],"wa":[4,26],"water":[2,4],"we":[2,3,4,26],"weight":26,"welcom":[0,3],"well":[3,4,12,18,20,22,25,26],"well_coord":2,"wells_sit":[5,16,18],"wet":2,"wheel":21,"when":26,"where":[2,4,22],"which":[2,4,21,22,26],"while":[2,4,21,26],"whole":22,"width":2,"window":20,"without":[2,15,24],"work":[3,21],"world":[20,24],"would":[21,22],"write":[2,4,9,13,15,21,22],"write_fil":[5,8,13,15],"write_fold":[5,8,15],"write_folder_it":[5,8,9],"write_grid":[5,8,15],"write_properti":[5,8,15],"writefil":[5,8],"written":[4,22,26],"wsl":21,"www":21,"x":[2,4,9,13,15,18,26],"xf":2,"xformat":[4,26],"xi":2,"xlnum":[4,26],"xunit":[4,26],"xy":[13,22],"xypolygon":4,"y":[2,4,9,13,18,26],"ye":4,"year":26,"yf":2,"yformat":[4,26],"yi":2,"ylnum":[4,26],"yml":[3,21,26],"you":[3,4,21,26],"your":[2,3,21,26],"yournam":3,"yunit":[4,26],"z":[2,4,11,13,18,22,26],"z_xy":2,"zag":2,"zf":2,"zi":2,"zig":2,"zone":22,"zprofil":21},"titles":["About expreccs","expreccs Python API","Configuration file","Contributing","Examples","expreccs package","expreccs.core package","expreccs.core.expreccs module","expreccs.utils package","expreccs.utils.backcoupling module","expreccs.utils.inputvalues module","expreccs.utils.mapboundaries module","expreccs.utils.mapproperties module","expreccs.utils.reg_sit_given_decks module","expreccs.utils.runs module","expreccs.utils.writefile module","expreccs.visualization package","expreccs.visualization.maps2d module","expreccs.visualization.plotting module","expreccs.visualization.reading module","Welcome to the expreccs\u2019s documentation!","Installation","Introduction","expreccs","Output folder","Related","TCCS-13"],"titleterms":{"":20,"13":26,"about":0,"ad":25,"api":1,"backcoupl":9,"binari":21,"boundari":4,"brew":21,"build":21,"concept":22,"configur":[2,4,24],"content":[5,6,8,16],"contribut":3,"core":[6,7],"deck":[4,24],"document":20,"exampl":4,"exprecc":[0,1,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,23],"file":[2,4,24],"flow":[4,21,24],"folder":24,"formula":21,"ground":3,"hello":4,"indic":20,"inputvalu":10,"instal":21,"introduct":22,"issu":3,"layer":4,"linux":21,"maco":21,"mapboundari":11,"mapproperti":12,"maps2d":17,"micp":25,"model":4,"modul":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19],"non":4,"opm":[4,21,24],"output":24,"overview":22,"packag":[5,6,8,16,21],"paramet":2,"plopm":25,"plot":18,"pofff":25,"problem":3,"pycopm":25,"pymm":25,"pyopmnearwel":25,"pyopmspe11":25,"python":[1,21],"read":19,"reg_sit_given_deck":13,"regular":4,"relat":[2,25],"report":3,"reservoir":2,"result":2,"rock":2,"rule":3,"run":14,"seek":3,"simul":2,"softwar":3,"sourc":21,"submodul":[6,8,16],"subpackag":5,"support":3,"tabl":20,"tcc":26,"util":[8,9,10,11,12,13,14,15],"via":[4,24],"visual":[16,17,18,19],"welcom":20,"well":2,"window":21,"world":4,"writefil":15}})
\ No newline at end of file
+Search.setIndex({"alltitles":{"About expreccs":[[0,null]],"Binary packages":[[21,"binary-packages"]],"Brew formula for macOS":[[21,"brew-formula-for-macos"]],"Concept":[[22,"concept"]],"Configuration file":[[2,null]],"Contribute to the software":[[3,"contribute-to-the-software"]],"Contributing":[[3,null]],"Examples":[[4,null]],"Ground Rules":[[3,"ground-rules"]],"Hello world":[[4,"hello-world"]],"Indices and tables":[[20,"indices-and-tables"]],"Installation":[[21,null]],"Introduction":[[22,null]],"Layered model":[[4,"layered-model"]],"Module contents":[[5,"module-expreccs"],[6,"module-expreccs.core"],[8,"module-expreccs.utils"],[16,"module-expreccs.visualization"]],"Non-regular boundaries":[[4,"non-regular-boundaries"]],"OPM Flow":[[21,"opm-flow"]],"Output folder":[[24,null]],"Overview":[[22,"overview"]],"Python package":[[21,"python-package"]],"Regular boundaries":[[4,"regular-boundaries"]],"Related":[[25,null]],"Reporting issues or problems":[[3,"reporting-issues-or-problems"]],"Reservoir-related parameters":[[2,"reservoir-related-parameters"]],"Rock-related parameters":[[2,"rock-related-parameters"]],"Seek support":[[3,"seek-support"]],"Simulation results":[[2,"simulation-results"]],"Source build in Linux/Windows":[[21,"source-build-in-linux-windows"]],"Source build in macOS":[[21,"source-build-in-macos"]],"Submodules":[[6,"submodules"],[8,"submodules"],[16,"submodules"]],"Subpackages":[[5,"subpackages"]],"TCCS-13":[[26,null]],"Via OPM Flow decks":[[4,"via-opm-flow-decks"],[24,"via-opm-flow-decks"]],"Via configuration files":[[4,"via-configuration-files"],[24,"via-configuration-files"]],"Welcome to the expreccs\u2019s documentation!":[[20,null]],"Well-related parameters":[[2,"well-related-parameters"]],"ad-micp":[[25,"ad-micp"]],"expreccs":[[1,"expreccs"],[23,null]],"expreccs Python API":[[1,null]],"expreccs package":[[5,null]],"expreccs.core package":[[6,null]],"expreccs.core.expreccs module":[[7,null]],"expreccs.utils package":[[8,null]],"expreccs.utils.backcoupling module":[[9,null]],"expreccs.utils.inputvalues module":[[10,null]],"expreccs.utils.mapboundaries module":[[11,null]],"expreccs.utils.mapproperties module":[[12,null]],"expreccs.utils.reg_sit_given_decks module":[[13,null]],"expreccs.utils.runs module":[[14,null]],"expreccs.utils.writefile module":[[15,null]],"expreccs.visualization package":[[16,null]],"expreccs.visualization.maps2d module":[[17,null]],"expreccs.visualization.plotting module":[[18,null]],"expreccs.visualization.reading module":[[19,null]],"plopm":[[25,"plopm"]],"pofff":[[25,"pofff"]],"pycopm":[[25,"pycopm"]],"pymm":[[25,"pymm"]],"pyopmnearwell":[[25,"pyopmnearwell"]],"pyopmspe11":[[25,"pyopmspe11"]]},"docnames":["about","api","configuration_file","contributing","examples","expreccs","expreccs.core","expreccs.core.expreccs","expreccs.utils","expreccs.utils.backcoupling","expreccs.utils.inputvalues","expreccs.utils.mapboundaries","expreccs.utils.mapproperties","expreccs.utils.reg_sit_given_decks","expreccs.utils.runs","expreccs.utils.writefile","expreccs.visualization","expreccs.visualization.maps2d","expreccs.visualization.plotting","expreccs.visualization.reading","index","installation","introduction","modules","output_folder","related","tccs-13"],"envversion":{"sphinx":65,"sphinx.domains.c":3,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":9,"sphinx.domains.index":1,"sphinx.domains.javascript":3,"sphinx.domains.math":2,"sphinx.domains.python":4,"sphinx.domains.rst":2,"sphinx.domains.std":2},"filenames":["about.rst","api.rst","configuration_file.rst","contributing.rst","examples.rst","expreccs.rst","expreccs.core.rst","expreccs.core.expreccs.rst","expreccs.utils.rst","expreccs.utils.backcoupling.rst","expreccs.utils.inputvalues.rst","expreccs.utils.mapboundaries.rst","expreccs.utils.mapproperties.rst","expreccs.utils.reg_sit_given_decks.rst","expreccs.utils.runs.rst","expreccs.utils.writefile.rst","expreccs.visualization.rst","expreccs.visualization.maps2d.rst","expreccs.visualization.plotting.rst","expreccs.visualization.reading.rst","index.rst","installation.rst","introduction.rst","modules.rst","output_folder.rst","related.rst","tccs-13.rst"],"indexentries":{},"objects":{"":[[5,0,0,"-","expreccs"]],"expreccs":[[6,0,0,"-","core"],[8,0,0,"-","utils"],[16,0,0,"-","visualization"]],"expreccs.core":[[7,0,0,"-","expreccs"]],"expreccs.core.expreccs":[[7,1,1,"","check_cmdargs"],[7,1,1,"","expreccs"],[7,1,1,"","load_parser"],[7,1,1,"","main"]],"expreccs.utils":[[9,0,0,"-","backcoupling"],[10,0,0,"-","inputvalues"],[11,0,0,"-","mapboundaries"],[12,0,0,"-","mapproperties"],[13,0,0,"-","reg_sit_given_decks"],[14,0,0,"-","runs"],[15,0,0,"-","writefile"]],"expreccs.utils.backcoupling":[[9,1,1,"","backcoupling"],[9,1,1,"","compute_multipliers"],[9,1,1,"","init_multipliers"],[9,1,1,"","write_folder_iter"]],"expreccs.utils.inputvalues":[[10,1,1,"","check_entries"],[10,1,1,"","process_input"],[10,1,1,"","process_tuning"]],"expreccs.utils.mapboundaries":[[11,1,1,"","aquaflux"],[11,1,1,"","handle_pressure_correction"],[11,1,1,"","handle_stencil"],[11,1,1,"","handle_stencil_2p"],[11,1,1,"","porv_projections"],[11,1,1,"","porv_regional_segmentation"],[11,1,1,"","temporal_interpolation_flux"],[11,1,1,"","temporal_interpolation_pressure"]],"expreccs.utils.mapproperties":[[12,1,1,"","mapping_properties"],[12,1,1,"","positions_reference"],[12,1,1,"","positions_regional"],[12,1,1,"","positions_rotation"],[12,1,1,"","positions_site"],[12,1,1,"","rotate_grid"]],"expreccs.utils.reg_sit_given_decks":[[13,1,1,"","check_intersection"],[13,1,1,"","check_regional_neighbours"],[13,1,1,"","create_deck"],[13,1,1,"","dynamic_interpolator"],[13,1,1,"","extract_site_borders"],[13,1,1,"","find_ij_orientation"],[13,1,1,"","find_regional_cells"],[13,1,1,"","get_bccon"],[13,1,1,"","get_xymaps"],[13,1,1,"","handle_grid_coord"],[13,1,1,"","project_pressures"],[13,1,1,"","site_contour"],[13,1,1,"","temporal_interpolation"],[13,1,1,"","write_files"]],"expreccs.utils.runs":[[14,1,1,"","plotting"],[14,1,1,"","run_models"],[14,1,1,"","simulations"]],"expreccs.utils.writefile":[[15,1,1,"","compact_format"],[15,1,1,"","write_files"],[15,1,1,"","write_folders"],[15,1,1,"","write_grid"],[15,1,1,"","write_properties"]],"expreccs.visualization":[[17,0,0,"-","maps2d"],[18,0,0,"-","plotting"],[19,0,0,"-","reading"]],"expreccs.visualization.maps2d":[[17,1,1,"","final_time_maps"],[17,1,1,"","final_time_maps_difference"],[17,1,1,"","geological_maps"],[17,1,1,"","manage_name"]],"expreccs.visualization.plotting":[[18,1,1,"","handle_labels_difference"],[18,1,1,"","handle_labels_distance"],[18,1,1,"","handle_site_summary"],[18,1,1,"","over_time_distance"],[18,1,1,"","over_time_max_difference"],[18,1,1,"","over_time_sensor"],[18,1,1,"","plot_results"],[18,1,1,"","plotting_settings"],[18,1,1,"","positions"],[18,1,1,"","summary_plot"],[18,1,1,"","summary_site"],[18,1,1,"","wells_site"]],"expreccs.visualization.reading":[[19,1,1,"","define_cases"],[19,1,1,"","make_arrays"],[19,1,1,"","manage_names"],[19,1,1,"","reading_simulations"]]},"objnames":{"0":["py","module","Python module"],"1":["py","function","Python function"]},"objtypes":{"0":"py:module","1":"py:function"},"terms":{"":[2,3,4,21,22,24,26],"0":[2,4,15,22,24,26],"001":26,"00e":2,"01":2,"01013":2,"02":[4,21,26],"04":[3,21],"05e3":4,"0f":[4,26],"0pressur":26,"1":[2,4,21,22,26],"10":[2,21,26],"1000":2,"10000":2,"101":2,"1013":2,"10132":2,"10e3":4,"11":[21,26],"11000":2,"111":26,"112":26,"11377":2,"11423e":2,"116":26,"117":26,"11th":2,"12":[2,3,4,21,26],"126":26,"13":[3,20],"13140":26,"1324":2,"14":[2,21,26],"14518":2,"15":2,"15000":[2,4],"15e3":4,"16":[4,26],"160000":26,"18000":2,"193531e":2,"199":4,"1d":18,"1e":[2,26],"1e0":26,"1e1":2,"1e2":2,"1e3":2,"1e4":2,"1e5":2,"1e6":2,"1e7":2,"1e8":2,"1f":[4,26],"2":[2,4,22,26],"20":[2,4],"20000":2,"202":2,"2025":[21,26],"203":26,"21180":2,"21583":2,"217":26,"21718":2,"22":2,"24":[3,4,21,26],"24081":2,"24200":2,"24886":26,"24e3":4,"25":[2,4,26],"26":3,"2650":2,"27000":2,"2732":2,"28477":2,"2d":[17,18],"2e2":2,"2f":26,"3":[2,3,4,21,22,26],"30":[2,4,26],"3060":2,"3060e":2,"31":26,"31679":2,"319":4,"32":2,"324":2,"325":2,"336294":0,"33e3":4,"34":2,"365":2,"3870":2,"3b":26,"3e5":2,"4":[2,26],"41283":26,"417":4,"45":2,"450":26,"45000":2,"47":2,"48":26,"495000":26,"5":[2,4,26],"50":2,"500":4,"5000":2,"506":2,"50e3":4,"525":26,"55":2,"55e3":4,"56":26,"57":26,"5710":2,"5e6":2,"6":[2,4,26],"60":[2,26],"605e6":26,"60e3":4,"6120":2,"625":2,"63e":2,"65":[2,26],"650":2,"6625":2,"7":[2,22,26],"7068":2,"7122":2,"73":2,"7800":2,"8":[2,4,26],"80":26,"8000":2,"809":26,"80e3":4,"81":2,"8233":2,"8654":2,"8883":2,"9":[2,26],"92":2,"95":[4,26],"95000":26,"99e":2,"A":[9,25,26],"For":[0,2,3,4,21,26],"If":[2,4,21],"In":[2,3,4,22,24],"The":[0,1,2,3,4,21,22,24,26],"Then":[2,4,21,24,26],"There":21,"To":[2,4,21,26],"_":[9,26],"_build":3,"_of_input_fil":22,"abl":21,"about":[3,20],"abov":[2,26],"accept":3,"achiev":[2,4],"action":[3,21],"activ":[2,13,21,26],"actual":26,"ad":[2,9,10,20,21,22,26],"adapt":26,"add":[2,3,4,13,24],"addit":[1,2,3,4,24],"after":[4,12,21,24,26],"all":[2,3,4,21,22,26],"allow":[2,26],"along":[2,4,22],"also":[2,3,4,21,24],"altern":3,"an":[0,2,3,4,21,22,25],"anaconda":21,"analys":3,"ani":[2,3,4],"anim":4,"anoth":[4,21],"answer":3,"api":20,"appli":4,"applic":4,"approach":[0,2,3,4,22,26],"apt":21,"aquaflux":[5,8,11],"aquif":[2,26],"ar":[0,2,3,4,9,13,21,22,24,25,26],"arg":[7,9,10,11,12,13,14,15,17,18,19],"argument":[2,7,22],"arrai":[2,13,19,22],"assess":2,"avail":[2,21],"averag":26,"avoid":2,"b":[22,26],"back":[9,19],"backcoupl":[5,8],"bar":[2,26],"base":[4,9,22,25],"bc":[2,4,11,13,15,22,24],"bccon":24,"becom":22,"been":21,"befor":[3,26],"below":[4,25],"benchmark":25,"better":18,"between":[1,4,17,18,22],"bfebf2":26,"bhp":[2,4,18],"bin":[2,3,21],"binari":[3,13,20],"black":[3,26],"bool":19,"border":[13,18],"both":2,"bottom":[2,4],"boundari":[2,11,13,20,22,24],"box":2,"branch":21,"brew":20,"brg":26,"build":[2,3,4,13,20],"build_opm_mpi":21,"built":21,"c":[2,4,22,26],"calcit":25,"call":[4,24],"can":[2,3,4,21,24,26],"capabl":2,"capillari":2,"cardin":13,"carlson":2,"case":[4,15,19],"cbsfax":[4,26],"cd":21,"cell":[2,4,11,13,18,22,24,26],"cet_diverging_rainbow_bgymr_45_85_c67":26,"cfd":25,"cformat":[4,26],"chang":[2,3,4],"check":[7,10,13,21,25],"check_cmdarg":[5,6,7],"check_entri":[5,8,10],"check_intersect":[5,8,13],"check_regional_neighbour":[5,8,13],"checker":3,"checkout":21,"chosen":2,"ci":[3,21],"ci_pycopm_maco":3,"clabel":26,"clone":21,"close":2,"closest":[2,13,18],"cm":21,"cmake":21,"cmdarg":7,"cnum":26,"cnv":26,"co2":[2,4,22,25],"coarsen":26,"coarsened_improv":26,"coarsened_perm":26,"coarsened_tran":26,"coarser":2,"code":[3,5,21],"coeffici":22,"collabor":3,"color":18,"com":[4,21,22,26],"combin":7,"command":[2,4,7,21,26],"commit":3,"common":[21,26],"compact":15,"compact_format":[5,8,15],"compar":[2,4,22,24],"comparison":[1,4],"compens":9,"complet":[17,19],"complex":4,"compress":2,"comput":[2,9],"compute_multipli":[5,8,9],"concept":20,"condit":[2,4,22,24],"config":4,"configur":[1,10,20,22],"conform":22,"connect":[13,22,24],"conrour":13,"consid":[2,4],"contact":26,"contain":[1,3],"content":[1,3,20,23],"continu":2,"contour":[13,22],"contribut":[0,20,21],"control":[2,26],"cook":26,"coord":13,"coordin":[2,13,18],"copi":[3,21],"core":[1,5,23,26],"corner":[2,15,22],"correct":11,"correspond":[1,2,4,22,24],"could":[21,24,26],"council":0,"count":13,"counter":11,"coupl":[9,19],"cov":[3,4],"cp":2,"cpg":[2,22],"cpr_trueimp":26,"creat":[3,4,13,21,22,24],"create_deck":[5,8,13],"csp":[2,25],"cssr":[4,21,22,26],"curiou":4,"current":[9,18,21,22,26],"current_directori":21,"curv":2,"d":[2,4,26],"d_z":13,"dai":[2,4],"data":[4,19,26],"dcmake_build_typ":21,"de":24,"deactiv":2,"deck":[1,2,13,14,18,19,20,22,26],"dedic":21,"default":[2,22],"defin":[2,4,22],"define_cas":[5,16,19],"definit":[2,24],"delax":[4,26],"demonstr":4,"depend":[3,21,26],"depth":[2,26],"describ":[2,3,22,26],"desir":2,"detail":0,"dev":[3,21],"develop":[21,22],"dic":[9,10,11,12,13,14,15,17,18,19],"dict":[7,9,10,11,12,13,14,15,17,18,19],"dictionari":[9,10,11,12,13,14,15,17,18,19],"differ":[1,2,4,9,11,12,17,18,22,24],"dimens":[2,26],"dir":[2,11,13],"dire":13,"direct":[2,4,13],"directli":24,"director":26,"directori":[3,22],"discret":[2,22],"distanc":[4,18],"dmar":2,"do":[4,21,22],"doc":3,"document":[2,3,21,22,24],"doe":4,"doi":26,"done":[9,21],"doplot":19,"download":21,"duse_mpi":21,"dvipng":21,"dwith_ndebug":21,"dynam":[2,4,22,24,25],"dynamic_interpol":[5,8,13],"e":[2,3,4,21,22,24,26],"each":[2,22],"edg":21,"ehystr":2,"either":21,"els":21,"em":25,"email":3,"enabl":[2,26],"end":[2,4,26],"energi":0,"enter":2,"enterpris":21,"entri":[2,10,22],"environ":[3,21],"equal":[4,22],"equidist":22,"equinor":0,"error":2,"ert":26,"evalu":[2,22],"everest":26,"exampl":[2,20,24],"example1":[2,4],"example1_porvproj":4,"example1_pr":4,"example1_wel":[2,4],"example2":4,"except":2,"execut":[1,2,3,4,7,21,22,24,26],"exisit":26,"exist":21,"exmapl":2,"explain":4,"explicit":22,"expon":2,"exponenti":22,"export":3,"exprecc":[2,3,4,21,22,24,26],"expreccs_dpincreas":4,"expreccs_perfipnum":4,"expreccss":1,"extend":[2,3],"extra":21,"extract":[4,18],"extract_site_bord":[5,8,13],"f":[4,22,26],"face":11,"fals":19,"familiar":3,"fault":[2,12,22,26],"fault_region":2,"fault_sit":2,"featur":[0,26],"few":26,"fi":21,"fig":26,"fig1":26,"fig10a":26,"fig10bc":26,"fig12a":26,"fig2":26,"fig3b":26,"fig5":26,"fig6a":26,"fig6b":26,"fig8low":26,"fig8upp":26,"fig9":26,"figur":[4,14,17,19,21,22,26],"fil":9,"file":[1,3,10,13,15,19,20,21,22,26],"final":[2,4,26],"final_time_map":[5,16,17],"final_time_maps_differ":[5,16,17],"find":[12,13],"find_ij_orient":[5,8,13],"find_regional_cel":[5,8,13],"fipnum":[4,13,22],"fipr":13,"first":[2,19,26],"five":2,"fix":3,"flag":[2,4,7,22,24],"flexibl":22,"float":13,"flow":[2,3,14,15,19,20,25,26],"flow_maco":3,"fluid":2,"fluidflow":25,"flux":[2,4,9,11],"flux_region":9,"flux_sit":9,"focus":22,"fol":[18,19],"folder":[1,2,3,4,9,15,17,18,19,20,21,22,26],"follow":[2,4,21,22,24,26],"font":21,"fork":[0,3],"format":[3,21],"former":4,"formula":20,"fot":13,"fraction":[2,26],"framework":[2,22,25],"frequenc":22,"friend":4,"from":[2,3,4,9,10,11,13,18,19,21,22,25,26],"full":2,"function":[2,4,7,9,10,11,12,13,14,15],"fund":0,"further":[2,4],"g":[2,3,4,21,22,24],"ga":[2,4],"gasda":26,"gener":[1,2,3,4,14,22,24,25,26],"geolog":[1,2,4,9,14,15,22,25],"geological_map":[5,16,17],"get":[3,13,21,26],"get_bccon":[5,8,13],"get_xymap":[5,8,13],"gif":25,"gind":13,"git":[4,21,26],"github":[3,4,21,22,26],"give":2,"given":[1,2,4,9,13,22,24],"global":[9,10,11,12,13,14,15,17,18,19,26],"gnuplot2":26,"grade":22,"grid":[2,4,12,13,15,21,22,26],"ground":20,"group":2,"h":[2,26],"ha":[2,21,26],"hand":13,"handl":[12,22],"handle_grid_coord":[5,8,13],"handle_labels_differ":[5,16,18],"handle_labels_dist":[5,16,18],"handle_pressure_correct":[5,8,11],"handle_site_summari":[5,16,18],"handle_stencil":[5,8,11],"handle_stencil_2p":[5,8,11],"handli":22,"harbour":0,"hat":21,"height":2,"hello":[20,24],"hello_world":4,"hello_world_distance_from_bord":4,"hello_world_reference_watfluxi":4,"hello_world_regional_watfluxi":4,"hello_world_sensor_pressure_over_tim":4,"hello_world_site_flux_watfluxi":4,"hello_world_summary_bhp_site_refer":4,"help":[2,3,21],"here":[0,2,4,24,26],"heterogein":[2,22],"heterogen":4,"higher":2,"histori":25,"home":4,"homebrew":21,"homogen":26,"horizont":13,"host":22,"how":[4,26],"html":3,"http":[4,21,22,26],"hydrosta":13,"hysteresi":[2,22],"hystopt":2,"i":[0,1,2,3,4,9,11,13,18,21,22,24,26],"identifi":22,"ignor":3,"ij":4,"imag":[1,25],"imbibit":2,"imbnum":26,"implement":[2,22],"import":3,"improv":[18,22,26],"in_fil":10,"inact":[4,22],"inc":[4,24],"includ":[1,4,21,22],"increas":[4,22,26],"ind":13,"index":[13,18,20],"indic":[13,18],"induc":25,"init_multipli":[5,8,9],"initi":[2,9,13],"inj":2,"inject":[2,18],"injector":[2,4],"input":[1,2,4,9,10,14,22],"inputvalu":[5,8],"insid":[2,4,21],"instal":[3,4,20,26],"instead":2,"instruct":21,"int":[9,11,13,18],"integr":2,"interest":[2,21,25],"interp":2,"interpol":[2,4,11,13,24],"introduct":[4,20],"invalid":7,"irregular":22,"issu":[0,20],"iter":[2,9,11,15,26],"iterativli":9,"j":[18,22],"j5":21,"johansen":26,"jump":2,"kept":2,"keyword":2,"kg":2,"killough":2,"km":[4,26],"kr":2,"krn":2,"krw":2,"kxy":2,"kz":2,"l":[4,21,22,26],"label":[4,18,24],"landa":26,"last":[17,19],"later":4,"latest":21,"latex":21,"layer":[2,20,22],"leakag":25,"left":[2,4,13],"length":2,"librari":21,"lim":26,"limipr":26,"limit":[2,26],"line":[2,3,4,13,18,21],"linear":[2,26],"link":[0,21],"lint":21,"linux":20,"list":[13,15,18,19],"literatur":26,"load_pars":[5,6,7],"local":3,"locat":[1,2,4,11,12,18,22,26],"log":26,"look":[3,26],"lot":26,"lower":2,"m":[2,4,21,22,26],"machin":[2,21],"maco":[3,20],"macport":21,"mactex":21,"main":[1,3,5,6,7],"maintain":3,"make":[3,15,21],"make_arrai":[5,16,19],"mako":[1,15],"mamba":21,"manag":[18,21],"manage_nam":[5,16,17,19],"managua_r":26,"mani":2,"mantain":3,"manual":2,"manuscript":4,"map":[4,11,12,13,17,18,22],"mapboundari":[5,8],"mapp":4,"mapping_properti":[5,8,12],"mapproperti":[5,8],"maps2d":[5,16],"marb\u00e1n":26,"mark":22,"master":21,"match":[25,26],"max":[2,18,26],"maximum":[2,26],"md":2,"merg":3,"metric":22,"micp":20,"microbi":25,"microsystem":25,"middel":4,"middl":[2,4],"might":[3,21,25,26],"min":[2,26],"miniforg":21,"minimum":4,"miss":[3,4],"mkdir":21,"model":[1,2,9,13,14,15,17,19,20,22,24,25,26],"modif":22,"modifi":[9,10,11,12,13,14,15,17,18,19,21,24],"modul":[1,20,23,25],"more":[0,3,4],"mpi":21,"mpirun":[2,26],"mt":2,"mult":9,"multipli":[2,9],"mypi":3,"n":[2,4,13,15,22],"name":[2,4,9,10,14,15,17,18,19,22],"ndeck":18,"necessari":[4,15],"need":[3,21,22,26],"neighbour":13,"new":[0,3,4,10],"newton":[2,26],"newtoniterationcount":26,"nfol":18,"nice":[3,21,22],"nkrn":2,"nkrw":2,"nnc":13,"non":[2,20],"none":[7,9,10,14,15,17,18,22],"norwai":0,"norwegian":26,"notat":15,"now":[2,4],"np":[2,26],"npen":2,"npoint":2,"nqua":18,"nquan":18,"nrst":18,"num":2,"number":[0,2,9,13,18,22,26],"numpi":15,"nwell":18,"nx":22,"ny":22,"o":[4,22,24],"observ":2,"offset":[4,13,22],"offshor":26,"one":[2,4,24],"ones":26,"onli":[2,4,19,22],"onlin":21,"open":[2,21,25],"oper":[2,22],"opernum":[4,24],"opernum_exprecc":[4,24],"opm":[1,2,3,14,15,18,19,20,25,26],"opmn":18,"optim":[4,26],"optimal_solut":26,"option":[2,7,21,22],"order":2,"org":[21,26],"orginin":26,"origen":2,"origin":26,"other":21,"our":[3,4],"out":[17,19,25],"output":[2,15,18,19,20,22],"over":[2,13],"over_time_dist":[5,16,18],"over_time_max_differ":[5,16,18],"over_time_sensor":[5,16,18],"overlap":[4,13,24],"overpr":26,"overpressur":26,"overview":[2,20],"own":3,"p":[4,13,22,26],"packag":[1,3,4,20,23],"page":[3,4,20],"paper":26,"paper_2025":4,"parallel":26,"paramet":[10,20],"part":4,"partit":22,"path":[2,3,22],"path_to_the_regional_model":4,"path_to_the_site_model":4,"pc":2,"pcap":2,"pen":2,"per":[2,4,22],"period":2,"perm":[2,26],"permeabl":26,"phi":2,"pi":2,"pip":[3,4,21,26],"platform":21,"pleas":[0,3],"plopm":[4,20,21,24,26],"plot":[5,8,14,15,16,17,19,22,24],"plot_result":[5,16,18],"plotting_set":[5,16,18],"plume":4,"png":[1,4,25],"pofff":20,"point":[2,15,18,22],"pore":[2,4,11,26],"poro":26,"porv":[2,26],"porv_project":[5,8,11],"porv_regional_segment":[5,8,11],"porvproj":[2,4],"posit":[2,5,12,13,16,18],"positions_refer":[5,8,12],"positions_region":[5,8,12],"positions_rot":[5,8,12],"positions_sit":[5,8,12],"possibl":[2,3],"postprocess":[4,22,24,26],"powerpoint":26,"pr":3,"practic":2,"pre":[2,4,11],"precipit":25,"prefer":3,"prefix":15,"preprocess":[10,22,24],"prerequisit":21,"pres2p":2,"prescrib":4,"pressur":[1,2,4,11,13,18,22,24,26],"presur":2,"previou":[3,4,21],"problem":20,"proce":[2,4],"proceed":26,"process":[1,10,13],"process_input":[5,8,10],"process_tun":[5,8,10],"prod":2,"produc":[2,4],"project":[0,1,2,4,11,13,18,21,22,25],"project_pressur":[5,8,13],"prompt":26,"properti":[2,22,26],"pull":[0,3],"push":3,"pushd":3,"pv":[2,11,26],"pwd":21,"py":[4,24,26],"py312":3,"pycopm":[2,3,4,20,21,26],"pylint":3,"pymm":20,"pyopmnearwel":20,"pyopmspe11":[3,20],"pytest":[3,4],"python":[3,20,25,26],"python3":[21,26],"quantiti":[12,17,18,19],"quick":25,"quotat":22,"r":[2,3,4,21,26],"rais":[0,3],"rate":[2,18],"re":[17,18,19],"read":[5,11,16],"reading_simul":[5,16,19],"recent":21,"recommend":21,"record":2,"rectangl":[4,22],"red":21,"refer":[1,2,4,12,14,15,17,18,22,24],"reference_x_n":2,"reference_y_n":2,"reference_z_n":2,"refin":[2,4,11],"reg":[11,13],"reg_sit_given_deck":[5,8],"regard":[2,4],"region":[1,2,4,9,11,13,14,18,22,24],"regional_bctyp":2,"regional_dim":2,"regional_sit":22,"regional_x_n":2,"regional_y_n":2,"regional_z_n":2,"regul":4,"regular":20,"rel":2,"relat":[3,15,20,24],"relax":[2,26],"releas":21,"remedi":25,"remov":26,"repit":15,"replac":3,"repo":[3,21],"report":[4,13,20,22],"repositori":[3,21],"reproduc":26,"request":[0,3],"requier":[4,12],"requir":[2,3,10,21],"requiri":10,"rerun":4,"research":0,"reservoir":[4,12,15,17,18,20],"residu":2,"resinsight":[2,4,21,24,26],"resourc":26,"respect":[2,4],"rest":26,"restart":[2,13],"result":[4,20,21,24,26],"return":[7,9,10,11,12,13,14,15,17,18,19],"review":3,"rg":26,"right":[2,13],"rise":3,"rock":[20,22],"rock_comp":2,"rotat":[4,12,22],"rotate_grid":[5,8,12],"routin":[1,15,18],"row":2,"rpr":4,"rst":[2,26],"rule":20,"run":[1,2,3,4,5,8,15,21,22,24,26],"run_model":[5,8,14],"safu":2,"salin":2,"same":[2,4,26],"sand":2,"sandv":26,"sandwich":4,"sat":2,"satur":[2,4,18],"save":[4,15,24,26],"schedul":[2,4,11,18,22],"screenshot":[2,24],"script":[1,3,7,11,13,17,18,19,21],"search":20,"second":2,"section":[2,4,22],"see":[2,3,4,21,22,24],"seek":20,"select":[4,24],"send":3,"sensor":[2,4,18,26],"sensor_coord":2,"set":[2,4,10,12,18,21,22,26],"set1_r":4,"setuptool":21,"sga":4,"sh":21,"share":2,"shell":0,"should":[21,26],"show":[1,2,4,24],"shut":2,"side":[2,11,13,22],"similar":26,"similarli":2,"simillarli":2,"simpl":4,"simpler":2,"simpli":21,"simplic":4,"simplifi":22,"simul":[1,3,4,5,8,14,17,19,20,21,22,24,25],"sin":2,"sinc":[2,26],"singl":3,"sintef":26,"site":[1,2,4,9,11,12,13,14,17,18,22,24],"site_bctyp":2,"site_clos":[4,24],"site_contour":[5,8,13],"site_loc":2,"six":[2,3],"size":[2,4],"skip":[21,22,26],"sni":2,"so":21,"softwar":20,"solut":2,"solver":[24,26],"some":[4,15,24,25],"soon":3,"sourc":[3,20,25],"space":22,"spatial":13,"spe":2,"spe11":25,"specif":21,"speed":2,"squash":3,"src":3,"stage":[4,22],"start":[4,13],"statfjord":26,"static":[3,4],"step":[2,3,13,17,21,22,26],"storag":[15,22],"str":[9,10,13,14,15,17,18,19],"string":2,"studi":[2,4,14,25,26],"style":18,"subfig":[4,26],"subfold":[22,24],"submit":26,"submodel":4,"submodul":[1,5,23],"subpackag":[1,20,23],"subsystem":21,"succe":3,"succed":21,"sudo":21,"summari":18,"summary_plot":[5,16,18],"summary_sit":[5,16,18],"super":21,"support":[2,20,21,22,26],"suptitl":[4,26],"surfac":[2,17,18],"sw":2,"swi":2,"system":[2,3],"t":[2,22,26],"tag":21,"tailor":25,"take":26,"target":3,"tcc":20,"telescop":22,"temperatur":2,"templat":15,"temporal_interpol":[5,8,13],"temporal_interpolation_flux":[5,8,11],"temporal_interpolation_pressur":[5,8,11],"term":[3,4],"termin":[4,21],"test":[3,4,21,22],"test_2_generic_deck":4,"test_4_site_region":4,"test_generic_deck":24,"texliv":21,"than":[0,3],"thei":4,"them":[0,2,22],"thi":[2,3,4,9,21,22,24,26],"thick":[2,13],"those":26,"three":[2,4],"threshold":2,"through":21,"time":[2,11,13,17,22,26],"timestep":22,"toler":26,"toml":[2,4,10,22],"tool":[0,3,4,21,22,25,26],"top":[2,4,17,18],"total":26,"tracer":24,"tran":[2,26],"translat":26,"transmiss":26,"troll":26,"true":[2,19,26],"try":[3,21],"tsmaxz":2,"tug":21,"tune":[2,10],"turn":21,"tutori":[3,21],"two":[2,4,19,22],"txt":[3,21],"type":[4,21,25],"u":22,"ubuntu":[3,21],"until":2,"up":2,"updat":[9,22],"upgrad":21,"upper":2,"us":[0,2,3,4,9,15,18,19,21,22,24,25,26],"user":[2,3,21],"util":[1,5,23],"utilii":[9,10,11,12,13,14,15],"v":[4,26],"v2025":21,"v2026":21,"valid":22,"valu":[2,4,10,11,13,15,22,26],"variabl":[2,3,4,15],"veloc":4,"venv":21,"version":[3,5,21,26],"vertic":13,"vexprecc":21,"via":[2,20,21,26],"virtual":21,"visit":3,"visual":[1,2,4,5,21,23,24],"volum":[2,4,11,26],"vtk":25,"w":[2,4,22,26],"wa":[4,26],"water":[2,4],"we":[2,3,4,26],"weight":26,"welcom":[0,3],"well":[3,4,12,18,20,22,25,26],"well_coord":2,"wells_sit":[5,16,18],"wet":2,"wheel":21,"when":26,"where":[2,4,22],"which":[2,4,21,22,26],"while":[2,4,21,26],"whole":22,"width":2,"window":20,"without":[2,15,24],"work":[3,21],"world":[20,24],"would":22,"write":[2,4,9,13,15,21,22],"write_fil":[5,8,13,15],"write_fold":[5,8,15],"write_folder_it":[5,8,9],"write_grid":[5,8,15],"write_properti":[5,8,15],"writefil":[5,8],"written":[4,22,26],"wsl":21,"www":21,"x":[2,4,9,13,15,18,26],"xf":2,"xformat":[4,26],"xi":2,"xlnum":[4,26],"xunit":[4,26],"xy":[13,22],"xypolygon":4,"y":[2,4,9,13,18,26],"ye":4,"year":26,"yf":2,"yformat":[4,26],"yi":2,"ylnum":[4,26],"yml":[3,21,26],"you":[3,4,21,26],"your":[2,3,26],"yournam":3,"yunit":[4,26],"z":[2,4,11,13,18,22,26],"z_xy":2,"zag":2,"zf":2,"zi":2,"zig":2,"zone":22},"titles":["About expreccs","expreccs Python API","Configuration file","Contributing","Examples","expreccs package","expreccs.core package","expreccs.core.expreccs module","expreccs.utils package","expreccs.utils.backcoupling module","expreccs.utils.inputvalues module","expreccs.utils.mapboundaries module","expreccs.utils.mapproperties module","expreccs.utils.reg_sit_given_decks module","expreccs.utils.runs module","expreccs.utils.writefile module","expreccs.visualization package","expreccs.visualization.maps2d module","expreccs.visualization.plotting module","expreccs.visualization.reading module","Welcome to the expreccs\u2019s documentation!","Installation","Introduction","expreccs","Output folder","Related","TCCS-13"],"titleterms":{"":20,"13":26,"about":0,"ad":25,"api":1,"backcoupl":9,"binari":21,"boundari":4,"brew":21,"build":21,"concept":22,"configur":[2,4,24],"content":[5,6,8,16],"contribut":3,"core":[6,7],"deck":[4,24],"document":20,"exampl":4,"exprecc":[0,1,5,6,7,8,9,10,11,12,13,14,15,16,17,18,19,20,23],"file":[2,4,24],"flow":[4,21,24],"folder":24,"formula":21,"ground":3,"hello":4,"indic":20,"inputvalu":10,"instal":21,"introduct":22,"issu":3,"layer":4,"linux":21,"maco":21,"mapboundari":11,"mapproperti":12,"maps2d":17,"micp":25,"model":4,"modul":[5,6,7,8,9,10,11,12,13,14,15,16,17,18,19],"non":4,"opm":[4,21,24],"output":24,"overview":22,"packag":[5,6,8,16,21],"paramet":2,"plopm":25,"plot":18,"pofff":25,"problem":3,"pycopm":25,"pymm":25,"pyopmnearwel":25,"pyopmspe11":25,"python":[1,21],"read":19,"reg_sit_given_deck":13,"regular":4,"relat":[2,25],"report":3,"reservoir":2,"result":2,"rock":2,"rule":3,"run":14,"seek":3,"simul":2,"softwar":3,"sourc":21,"submodul":[6,8,16],"subpackag":5,"support":3,"tabl":20,"tcc":26,"util":[8,9,10,11,12,13,14,15],"via":[4,24],"visual":[16,17,18,19],"welcom":20,"well":2,"window":21,"world":4,"writefil":15}})
\ No newline at end of file
diff --git a/docs/text/contributing.rst b/docs/text/contributing.rst
index 5c81b31..7e66712 100644
--- a/docs/text/contributing.rst
+++ b/docs/text/contributing.rst
@@ -22,14 +22,14 @@ Contribute to the software
#. In the main repo execute:
#. **pip install -r dev-requirements.txt** (this installs the `dev-requirements.txt `_)
- #. **black src/ tests/** (this formats the code)
+ #. **black --target-version py312 src/ tests/** (this formats the code)
#. **pylint src/ tests/** (this analyses the code, and might rise issues that need to be fixed before the pull request)
#. **mypy \-\-ignore-missing-imports src/ tests/** (this is a static checker, and might rise issues that need to be fixed before the pull request)
#. **pytest \-\-cov=expreccs \-\-cov-report term-missing tests/** (this runs locally the tests, and might rise issues that need to be fixed before the pull request)
#. **pushd docs & make html** (this generates the documentation, and might rise issues that need to be fixed before the pull request; if the build succeeds and if the contribution changes the documentation, then copy all content from the docs/_build/html/ folder and replace the files in the `docs `_ folder)
.. tip::
- See the `CI.yml `_ script and the `Actions `_ for installation of expreccs, OPM Flow (binary packages), and dependencies, as well as the execution of the six previous steps in Ubuntu 24.04 using Python 3.11.
+ See the `CI.yml `_ script and the `Actions `_ for installation of expreccs, OPM Flow (binary packages), and dependencies, as well as the execution of the six previous steps in Ubuntu 24.04 using Python 3.12.
For macOS users, see the `ci_pycopm_macos.yml `_ script and the `OPM-Flow_macOS Actions `_ for installation of pycopm (a related tool to expreccs), OPM Flow (source build), and dependencies in macOS 26 using Python 3.13.
In addition for macOS, you need to add the directory containing the OPM Flow executable to your system's PATH environment variable (e.g., export PATH=$PATH:/Users/yourname/pyopmspe11/build/opm-simulators/bin).
diff --git a/docs/text/installation.rst b/docs/text/installation.rst
index 2707a1a..092ae35 100644
--- a/docs/text/installation.rst
+++ b/docs/text/installation.rst
@@ -79,13 +79,13 @@ supported either via source builds or through running a virtual machine.
.. tip::
See the `CI.yml `_ script
- for installation of OPM Flow (binary packages), LaTeX (optional) libraries, and the expreccs package in Ubuntu 24.04 and Python 3.11.
+ for installation of OPM Flow (binary packages), LaTeX (optional) libraries, and the expreccs package in Ubuntu 24.04 and Python 3.12.
Source build in Linux/Windows
+++++++++++++++++++++++++++++
If you are a Linux user (including the Windows subsystem for Linux, see `this link `_
for a nice tutorial for setting Python environments in WSL), then you could try to build Flow (after installing the `prerequisites `_) from the master branches with mpi support by running
-in the terminal the following lines (which in turn should build flow in the folder ./build/opm-simulators/bin/flow.):
+in the terminal the following lines (which in turn should build flow in the folder ./build/opm-simulators/bin/flow):
.. code-block:: console
@@ -97,7 +97,7 @@ in the terminal the following lines (which in turn should build flow in the fold
do git clone https://github.com/OPM/opm-$repo.git
mkdir build/opm-$repo
cd build/opm-$repo
- cmake -DUSE_MPI=1 -DWITH_NDEBUG=1 -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH="$CURRENT_DIRECTORY/build/opm-common;$CURRENT_DIRECTORY/build/opm-grid" $CURRENT_DIRECTORY/opm-$repo
+ cmake -DUSE_MPI=1 -DWITH_NDEBUG=1 -DCMAKE_BUILD_TYPE=Release $CURRENT_DIRECTORY/opm-$repo
if [[ $repo == simulators ]]; then
make -j5 flow
else
@@ -117,7 +117,7 @@ Brew formula for macOS
++++++++++++++++++++++
For macOS, there are no available binary packages, so OPM Flow needs to be built from source. Recently, a formula to build flow using brew has
been added in `https://github.com/cssr-tools/homebrew-opm `_.
-Then, you can try to install flow (v2025.10) by simply typing:
+Then, you can try to install flow (v2026.02) by simply typing:
.. code-block:: console
@@ -130,46 +130,4 @@ You can check if the installation of OPM Flow succeded by typing in the terminal
Source build in macOS
+++++++++++++++++++++
-If you would like to build the latest OPM Flow from the master branch, then you can first install the prerequisites using brew:
-
-.. code-block:: console
-
- brew install cjson boost openblas suite-sparse python@3.14 cmake
-
-In addition, it is recommended to uprade and update your macOS to the latest available versions (the following steps have
-worked for macOS Tahoe 26.2.0 with Apple clang version 17.0.0).
-After the prerequisites are installed, then building OPM Flow can be achieved with the following bash lines:
-
-.. code-block:: console
-
- CURRENT_DIRECTORY="$PWD"
-
- for module in common geometry grid istl
- do git clone https://gitlab.dune-project.org/core/dune-$module.git
- cd dune-$module && git checkout v2.10.0 && cd ..
- ./dune-common/bin/dunecontrol --only=dune-$module cmake -DCMAKE_DISABLE_FIND_PACKAGE_MPI=1
- ./dune-common/bin/dunecontrol --only=dune-$module make -j5
- done
-
- mkdir build
-
- for repo in common grid simulators
- do git clone https://github.com/OPM/opm-$repo.git
- mkdir build/opm-$repo && cd build/opm-$repo
- cmake -DUSE_MPI=0 -DWITH_NDEBUG=1 -DCMAKE_BUILD_TYPE=Release -DCMAKE_PREFIX_PATH="$CURRENT_DIRECTORY/dune-common/build-cmake;$CURRENT_DIRECTORY/dune-grid/build-cmake;$CURRENT_DIRECTORY/dune-geometry/build-cmake;$CURRENT_DIRECTORY/dune-istl/build-cmake;$CURRENT_DIRECTORY/build/opm-common;$CURRENT_DIRECTORY/build/opm-grid" $CURRENT_DIRECTORY/opm-$repo
- if [[ $repo == simulators ]]; then
- make -j5 flow
- else
- make -j5 opm$repo
- fi
- cd ../..
- done
-
- echo "export PATH=\$PATH:$CURRENT_DIRECTORY/build/opm-simulators/bin" >> ~/.zprofile
- source ~/.zprofile
-
-This builds OPM Flow, and it exports the path to the flow executable. You can check if the installation of OPM Flow succeded by typing in the terminal **flow \-\-help**.
-
-.. tip::
- See `this repository `_ dedicated to build OPM Flow from source in the latest macOS (GitHub actions).
- If you still face problems, raise an issue in the GitHub repository, or you could also send an email to the maintainers.
+See `this repository `_ dedicated to build OPM Flow from source in the latest macOS (GitHub actions), and tested with **pycopm**, another repository in cssr-tools.