You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -46,10 +46,10 @@ See the [_installation_](https://cssr-tools.github.io/exprecss/installation.html
46
46
## Running expreccs
47
47
You can run _expreccs_ as a single command line:
48
48
```
49
-
expreccs -i name_of_input_file
49
+
expreccs -i name(s)_of_input_file(s)
50
50
```
51
51
Run `expreccs --help` to see all possible command line argument options. Inside the `configuration_file.txt` file you provide the path to the
52
-
flow executable and simulation parameters. See the .txt files in the [_examples_](https://github.com/cssr-tools/expreccs/tree/main/examples) and [_tests_](https://github.com/cssr-tools/expreccs/tree/main/tests/configs) folders.
52
+
flow executable and simulation parameters. To write dynamic boundary conditions from a given regional model to a site model, this can be achieved by giving the path to the models (i.e., without a configuration file). See the [_examples_](https://github.com/cssr-tools/expreccs/tree/main/examples) and [_tests_](https://github.com/cssr-tools/expreccs/tree/main/tests/configs) folders.
53
53
54
54
## Getting started
55
55
See the [_examples_](https://cssr-tools.github.io/expreccs/examples.html) in the [_documentation_](https://cssr-tools.github.io/expreccs/introduction.html).
@@ -66,6 +66,6 @@ The following is a list of manuscripts in which _expreccs_ is used:
66
66
1. Gasda, S.E., et al., 2024. Quantifying the impact of regional-scale pressure interference on commercial CO2 storage targets for multiple licenses. http://dx.doi.org/10.2139/ssrn.5053633.
67
67
68
68
## About expreccs
69
-
The _expreccs_ package is funded by Wintershall Dea, Equinor, Shell, and the Research Council of Norway [project number 336294].
69
+
The _expreccs_ package is funded by Harbour Energy, Equinor, Shell, and the Research Council of Norway [project number 336294].
70
70
This is work in progress. [_Here_](https://www.norceresearch.no/en/projects/expansion-of-resources-for-co2-storage-on-the-horda-platform-expreccs) is the link to the project details.
71
71
Contributions are more than welcome using the fork and pull request approach. For new features, please request them raising an issue.
Copy file name to clipboardExpand all lines: docs/_sources/introduction.rst.txt
+4-3
Original file line number
Diff line number
Diff line change
@@ -28,20 +28,21 @@ The current implementation supports the following executable with the argument o
28
28
29
29
.. code-block:: bash
30
30
31
-
expreccs -i name_of_input_file
31
+
expreccs -i name(s)_of_input_file(s)
32
32
33
33
where
34
34
35
-
-i The base name of the :doc:`configuration file <./configuration_file>` ('input.txt' by default).
35
+
-i The base name of the :doc:`configuration file <./configuration_file>`; or paths (space between them and quotation marks) to the regional and site models ('input.txt' by default).
36
36
-o The base name of the :doc:`output folder <./output_folder>` ('output' by default).
37
37
-m Run the whole framework ('all'), only the reference ('reference'), only the site ('site'), or only regional and site models ('noreference') ('all' by default).
38
38
-c Generate metric plots for the current outputed folders ('compare') ('' by default).
39
39
-p Create nice figures in the postprocessing folder ('no' by default).
40
40
-r Using the 'opm' or 'resdata' python package ('resdata' by default).
41
41
-u Using 'gasoil' or 'gaswater' co2store implementation ('gaswater' by default).
42
42
-t Grades to rotate the site geological model ('0' by default).
43
-
-e Name of the regional and site folders to project pressures ('' by default).
44
43
-b Set the number of entries to skip the bc projections on the site, where 'j=0,i=nx,j=ny,i=0', e.g., '0,2,0,0' would skip all cells with i=nx and i=nx-1; this becomes handly for models where all cells in a given site are inactive along a side ('0,0,0,0' by default).
44
+
-f Frequency to evaluate the boundary pressures on the site between report steps in the site. Write an array, e.g., '2,7,3', to set the frequency in each site report step ('1' by default).
45
+
-a Exponential 'a' coefficient for the telescopic time-discretization for the given frequency '-f'. Write an array, e.g., '2.2,0,3.1', to set the coefficient in each site report step ('3.2' by default, use 0 for an equidistance partition).
45
46
-w Set to 1 to print warnings ('0' by default).
46
47
-l Set to 0 to not use LaTeX formatting ('1' by default).
<spanclass="sig-prename descclassname"><spanclass="pre">expreccs.utils.reg_sit_given_decks.</span></span><spanclass="sig-name descname"><spanclass="pre">dynamic_mapping</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">dic</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink" href="#expreccs.utils.reg_sit_given_decks.dynamic_mapping" title="Link to this definition"></a></dt>
<spanclass="sig-prename descclassname"><spanclass="pre">expreccs.utils.reg_sit_given_decks.</span></span><spanclass="sig-name descname"><spanclass="pre">dynamic_interpolator</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">dic</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink" href="#expreccs.utils.reg_sit_given_decks.dynamic_interpolator" title="Link to this definition"></a></dt>
136
136
<dd><p>Project the pressures from the regional to the site over time</p>
137
137
<dlclass="simple">
138
138
<dt>Args:</dt><dd><p>dic (dict): Global dictionary</p>
<spanclass="sig-prename descclassname"><spanclass="pre">expreccs.utils.reg_sit_given_decks.</span></span><spanclass="sig-name descname"><spanclass="pre">project_pressures</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">dic</span></span></em>, <emclass="sig-param"><spanclass="n"><spanclass="pre">i</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink" href="#expreccs.utils.reg_sit_given_decks.project_pressures" title="Link to this definition"></a></dt>
196
196
<dd><p>Project the pressures at restart number i</p>
197
+
<dl>
198
+
<dt>Args:</dt><dd><p>dic (dict): Global dictionary</p>
199
+
<p>i (int): Index of report step in the site</p>
200
+
</dd>
201
+
<dt>Returns:</dt><dd><p>dic (dict): Modified global dictionary</p>
<spanclass="sig-prename descclassname"><spanclass="pre">expreccs.utils.reg_sit_given_decks.</span></span><spanclass="sig-name descname"><spanclass="pre">temporal_interpolation</span></span><spanclass="sig-paren">(</span><emclass="sig-param"><spanclass="n"><spanclass="pre">dic</span></span></em><spanclass="sig-paren">)</span><aclass="headerlink" href="#expreccs.utils.reg_sit_given_decks.temporal_interpolation" title="Link to this definition"></a></dt>
209
+
<dd><p>Function to interpolate BC pressure values in time</p>
197
210
<dlclass="simple">
198
211
<dt>Args:</dt><dd><p>dic (dict): Global dictionary</p>
Copy file name to clipboardExpand all lines: docs/genindex.html
+4-2
Original file line number
Diff line number
Diff line change
@@ -142,7 +142,7 @@ <h2 id="D">D</h2>
142
142
</li>
143
143
</ul></td>
144
144
<tdstyle="width: 33%; vertical-align: top;"><ul>
145
-
<li><ahref="expreccs.utils.reg_sit_given_decks.html#expreccs.utils.reg_sit_given_decks.dynamic_mapping">dynamic_mapping() (in module expreccs.utils.reg_sit_given_decks)</a>
145
+
<li><ahref="expreccs.utils.reg_sit_given_decks.html#expreccs.utils.reg_sit_given_decks.dynamic_interpolator">dynamic_interpolator() (in module expreccs.utils.reg_sit_given_decks)</a>
<li><ahref="expreccs.utils.mapboundaries.html#expreccs.utils.mapboundaries.temporal_interpolation_flux">temporal_interpolation_flux() (in module expreccs.utils.mapboundaries)</a>
479
+
<li><ahref="expreccs.utils.reg_sit_given_decks.html#expreccs.utils.reg_sit_given_decks.temporal_interpolation">temporal_interpolation() (in module expreccs.utils.reg_sit_given_decks)</a>
480
480
</li>
481
481
</ul></td>
482
482
<tdstyle="width: 33%; vertical-align: top;"><ul>
483
+
<li><ahref="expreccs.utils.mapboundaries.html#expreccs.utils.mapboundaries.temporal_interpolation_flux">temporal_interpolation_flux() (in module expreccs.utils.mapboundaries)</a>
484
+
</li>
483
485
<li><ahref="expreccs.utils.mapboundaries.html#expreccs.utils.mapboundaries.temporal_interpolation_pressure">temporal_interpolation_pressure() (in module expreccs.utils.mapboundaries)</a>
<dd><p>The base name of the <aclass="reference internal" href="configuration_file.html"><spanclass="doc">configuration file</span></a> (‘input.txt’ by default).</p>
114
+
<dd><p>The base name of the <aclass="reference internal" href="configuration_file.html"><spanclass="doc">configuration file</span></a>; or paths (space between them and quotation marks) to the regional and site models (‘input.txt’ by default).</p>
115
115
</dd>
116
116
<dt><kbd><spanclass="option">-o</span></kbd></dt>
117
117
<dd><p>The base name of the <aclass="reference internal" href="output_folder.html"><spanclass="doc">output folder</span></a> (‘output’ by default).</p>
@@ -134,12 +134,15 @@ <h2>Concept<a class="headerlink" href="#concept" title="Link to this heading">
134
134
<dt><kbd><spanclass="option">-t</span></kbd></dt>
135
135
<dd><p>Grades to rotate the site geological model (‘0’ by default).</p>
136
136
</dd>
137
-
<dt><kbd><spanclass="option">-e</span></kbd></dt>
138
-
<dd><p>Name of the regional and site folders to project pressures (’’ by default).</p>
139
-
</dd>
140
137
<dt><kbd><spanclass="option">-b</span></kbd></dt>
141
138
<dd><p>Set the number of entries to skip the bc projections on the site, where ‘j=0,i=nx,j=ny,i=0’, e.g., ‘0,2,0,0’ would skip all cells with i=nx and i=nx-1; this becomes handly for models where all cells in a given site are inactive along a side (‘0,0,0,0’ by default).</p>
142
139
</dd>
140
+
<dt><kbd><spanclass="option">-f</span></kbd></dt>
141
+
<dd><p>Frequency to evaluate the boundary pressures on the site between report steps in the site. Write an array, e.g., ‘2,7,3’, to set the frequency in each site report step (‘1’ by default).</p>
142
+
</dd>
143
+
<dt><kbd><spanclass="option">-a</span></kbd></dt>
144
+
<dd><p>Exponential ‘a’ coefficient for the telescopic time-discretization for the given frequency ‘-f’. Write an array, e.g., ‘2.2,0,3.1’, to set the coefficient in each site report step (‘3.2’ by default, use 0 for an equidistance partition).</p>
145
+
</dd>
143
146
<dt><kbd><spanclass="option">-w</span></kbd></dt>
144
147
<dd><p>Set to 1 to print warnings (‘0’ by default).</p>
0 commit comments