Extending the documentations

cssr-tools · Sep 13, 2024 · a4c8a02 · a4c8a02
1 parent ed0781e
commit a4c8a02
Show file tree

Hide file tree

Showing 10 changed files with 34 additions and 4 deletions.
diff --git a/docs/_images/hello_world_1.png b/docs/_images/hello_world_1.png
diff --git a/docs/_images/hello_world_2.png b/docs/_images/hello_world_2.png
diff --git a/docs/_sources/examples.rst.txt b/docs/_sources/examples.rst.txt
@@ -100,6 +100,17 @@ We use our `plopm <https://github.com/cssr-tools/plopm>`_ friend to generate PNG
     In the current implementation of the **pycopm** tool, the handling of properties that require definitions of i,j,k indices 
     (e.g., FAULTS, WELLSPECS) are assumed to be define in the main .DATA deck. Then, in order to use **pycopm** for simulation models 
     where these properties are define via include files, replace those includes in the .DATA deck with the actual content of the include files.
+    Here are some relevant keywords per deck section that need to be in the main input deck to coarse and not via include files:
+
+    SECTION GRID: MAPAXES, FAULTS, MULTREGT (other keywords like MULTZ, NTG, or definitions/operations for perms and poro can be in included files since 
+    permx, permy, permz, poro, porv, multx, multy, multz are read from the .INIT file)
+
+    SECTION PROPS: EQUALS, COPY, ADD, and MULTIPLY since this involve i,j,k indices and are apply to properties such as saturation functions parameters that
+    are still given in the same input format in the coarse deck. In addition, SWATINIT if used in the deck, is read from the .INIT file and output for the 
+    coarse model in a new file, then one might need to give the right include path to this special case. 
+
+    SECTION SCHEDULE: All keywords in this section must be in the input deck and no via include viles. 
+
 
 Drogon
 ------

diff --git a/docs/examples.html b/docs/examples.html
@@ -178,7 +178,14 @@ <h3>Smeaheia<a class="headerlink" href="#smeaheia" title="Link to this heading">
 <p class="admonition-title">Note</p>
 <p>In the current implementation of the <strong>pycopm</strong> tool, the handling of properties that require definitions of i,j,k indices
 (e.g., FAULTS, WELLSPECS) are assumed to be define in the main .DATA deck. Then, in order to use <strong>pycopm</strong> for simulation models
-where these properties are define via include files, replace those includes in the .DATA deck with the actual content of the include files.</p>
+where these properties are define via include files, replace those includes in the .DATA deck with the actual content of the include files.
+Here are some relevant keywords per deck section that need to be in the main input deck to coarse and not via include files:</p>
+<p>SECTION GRID: MAPAXES, FAULTS, MULTREGT (other keywords like MULTZ, NTG, or definitions/operations for perms and poro can be in included files since
+permx, permy, permz, poro, porv, multx, multy, multz are read from the .INIT file)</p>
+<p>SECTION PROPS: EQUALS, COPY, ADD, and MULTIPLY since this involve i,j,k indices and are apply to properties such as saturation functions parameters that
+are still given in the same input format in the coarse deck. In addition, SWATINIT if used in the deck, is read from the .INIT file and output for the
+coarse model in a new file, then one might need to give the right include path to this special case.</p>
+<p>SECTION SCHEDULE: All keywords in this section must be in the input deck and no via include viles.</p>
 </div>
 </section>
 <section id="drogon">

diff --git a/docs/searchindex.js b/docs/searchindex.js
diff --git a/docs/text/examples.rst b/docs/text/examples.rst
@@ -100,6 +100,17 @@ We use our `plopm <https://github.com/cssr-tools/plopm>`_ friend to generate PNG
     In the current implementation of the **pycopm** tool, the handling of properties that require definitions of i,j,k indices 
     (e.g., FAULTS, WELLSPECS) are assumed to be define in the main .DATA deck. Then, in order to use **pycopm** for simulation models 
     where these properties are define via include files, replace those includes in the .DATA deck with the actual content of the include files.
+    Here are some relevant keywords per deck section that need to be in the main input deck to coarse and not via include files:
+
+    SECTION GRID: MAPAXES, FAULTS, MULTREGT (other keywords like MULTZ, NTG, or definitions/operations for perms and poro can be in included files since 
+    permx, permy, permz, poro, porv, multx, multy, multz are read from the .INIT file)
+
+    SECTION PROPS: EQUALS, COPY, ADD, and MULTIPLY since this involve i,j,k indices and are apply to properties such as saturation functions parameters that
+    are still given in the same input format in the coarse deck. In addition, SWATINIT if used in the deck, is read from the .INIT file and output for the 
+    coarse model in a new file, then one might need to give the right include path to this special case. 
+
+    SECTION SCHEDULE: All keywords in this section must be in the input deck and no via include viles. 
+
 
 Drogon
 ------

diff --git a/docs/text/figs/hello_world_1.png b/docs/text/figs/hello_world_1.png
diff --git a/docs/text/figs/hello_world_2.png b/docs/text/figs/hello_world_2.png
diff --git a/tests/decks/HELLO_WORLD.DATA b/tests/decks/HELLO_WORLD.DATA
@@ -118,6 +118,7 @@ PERMZ
 EQUALS
 PORO 0 6 10 1* 1* 6 10 /
 PORO 0.08 8 8 1* 1* 8 8 /
+PORO 0 16 20 1* 1* 16 20 /
 /
 ---------------------------------------------------------------------------
 PROPS

diff --git a/tests/test_generic_deck.py b/tests/test_generic_deck.py
@@ -72,9 +72,9 @@ def test_generic_deck():
             "-n",
             "mode",
             "-x",
-            "0,0,0,0,0,2,2,2,2,2,0,0,0,0,0,0,0,0,0,0,0",
+            "0,0,0,0,0,0,2,2,2,2,0,0,0,0,0,0,0,0,0,0,0",
             "-z",
-            "0,0,0,0,0,0,0,0,0,0,0,0,0,2,2,2,2,2,0,0,0",
+            "0,2,2,2,0,0,0,0,0,0,0,0,2,2,2,2,2,2,0,0,0",
         ],
         check=True,
     )
-Original file line number
+Diff line change
@@ Expand Up / @@ -118,6 +118,7 @@ PERMZ @@
     EQUALS
     PORO 0 6 10 1* 1* 6 10 /
     PORO 0.08 8 8 1* 1* 8 8 /
+    PORO 0 16 20 1* 1* 16 20 /
     /
     ---------------------------------------------------------------------------
     PROPS
@@ Expand Down @@