subscript 1.1.0__tar.gz → 1.1.1__tar.gz

{subscript-1.1.0 → subscript-1.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: subscript
-Version: 1.1.0
+Version: 1.1.1
 Summary: Equinor's collection of subsurface reservoir modelling scripts
 Author-email: Equinor <rnyb@equinor.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -699,7 +699,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: configsuite
 Requires-Dist: resdata
-Requires-Dist: ecl2df
+Requires-Dist: res2df
 Requires-Dist: ert>=2.38.0b7
 Requires-Dist: fmu-tools
 Requires-Dist: matplotlib

{subscript-1.1.0 → subscript-1.1.1}/docs/overview.rst

@@ -10,7 +10,6 @@ Script                    CLI  ERT Forward Model  ERT Workflow
 bjobsusers                ✅   ⛔️                 ⛔️
 casegen_upcars            ✅   ⛔️                 ⛔️
 check_swatinit            ✅   ✅                 ⛔️
-co2_containment           ✅   ⛔️                 ⛔️
 convert_grid_format [*]_  ✅   ✅                 ⛔️
 csv2ofmvol                ✅   ✅                 ⛔️
 csv_merge                 ✅   ⛔️                 ✅

{subscript-1.1.0 → subscript-1.1.1}/docs/scripts/prtvol2csv.rst

@@ -130,5 +130,5 @@ file has been supplied defining the map from zones and regions to FIPNUM:
 See also
 --------
 
-* https://equinor.github.io/ecl2df/usage/fipreports.html can be used to extract
+* https://equinor.github.io/res2df/usage/fipreports.html can be used to extract
   more information from  the PRT files.

{subscript-1.1.0 → subscript-1.1.1}/pyproject.toml

@@ -37,7 +37,7 @@ dynamic = ["version"]
 dependencies = [
     "configsuite",
     "resdata",
-    "ecl2df",
+    "res2df",
     "ert>=2.38.0b7",
     "fmu-tools",
     "matplotlib",
@@ -91,7 +91,6 @@ Documentation = "https://equinor.github.io/subscript"
 bjobsusers = "subscript.bjobsusers.bjobsusers:main"
 casegen_upcars = "subscript.casegen_upcars.casegen_upcars:main"
 check_swatinit = "subscript.check_swatinit.check_swatinit:main"
-co2_containment = "subscript.co2_containment.co2_containment:main"
 convert_grid_format = "subscript.convert_grid_format.convert_grid_format:main"
 csv2ofmvol = "subscript.csv2ofmvol.csv2ofmvol:main"
 csv_merge = "subscript.csv_merge.csv_merge:main"

{subscript-1.1.0 → subscript-1.1.1}/src/subscript/check_swatinit/check_swatinit.py

@@ -3,9 +3,9 @@ import argparse
 import sys
 from typing import Any, Dict, List
 
-import ecl2df
 import numpy as np
 import pandas as pd
+import res2df
 from matplotlib import pyplot
 
 import subscript
@@ -58,7 +58,7 @@ def main() -> None:
     if args.DATAFILE.endswith(".csv"):
         qc_frame = pd.read_csv(args.DATAFILE)
     else:
-        eclfiles = ecl2df.EclFiles(args.DATAFILE)
+        eclfiles = res2df.ResdataFiles(args.DATAFILE)
 
         # Fail hard if the deck is not suitable for this tool or
         # give warnings/hints to the user:
@@ -102,11 +102,11 @@ def main() -> None:
         pyplot.savefig(args.plotfile)
 
 
-def check_applicability(eclfiles: ecl2df.EclFiles) -> None:
+def check_applicability(eclfiles: res2df.ResdataFiles) -> None:
     """Check that the input is relevant for usage with check_swatinit. This
     function may raise exceptions, SystemExit or only give warnings"""
 
-    deck = eclfiles.get_ecldeck()
+    deck = eclfiles.get_deck()
 
     init = eclfiles.get_initfile()
     if (
@@ -212,7 +212,7 @@ def human_report_pc_scaling(qc_frame: pd.DataFrame) -> str:
     return string
 
 
-def make_qc_gridframe(eclfiles: ecl2df.EclFiles) -> pd.DataFrame:
+def make_qc_gridframe(eclfiles: res2df.ResdataFiles) -> pd.DataFrame:
     """Construct a dataframe with needed information for swatinit qc from an
     Eclipse run.
 
@@ -220,7 +220,7 @@ def make_qc_gridframe(eclfiles: ecl2df.EclFiles) -> pd.DataFrame:
     satfunc and equil merged in.
     """
 
-    grid_df = ecl2df.grid.df(
+    grid_df = res2df.grid.df(
         eclfiles,
         vectors=[
             # All of these are required.
@@ -242,14 +242,14 @@ def make_qc_gridframe(eclfiles: ecl2df.EclFiles) -> pd.DataFrame:
         rstdates="first",
     )
 
-    # Circumvent bug in ecl2df that will pick SWL from both INIT and restart file:
+    # Circumvent bug in res2df that will pick SWL from both INIT and restart file:
     grid_df = grid_df.loc[:, ~grid_df.columns.duplicated()]
 
     # Merge in PPCWMAX from the deck, it is not reported in binary output files:
-    if "PPCWMAX" in eclfiles.get_ecldeck():
+    if "PPCWMAX" in eclfiles.get_deck():
         grid_df["PPCWMAX"] = ppcwmax_gridvector(eclfiles)
 
-    # This will be unneccessary from ecl2df 0.13.0:
+    # This will be unneccessary from res2df 0.13.0:
     grid_df = grid_df.where(grid_df > -1e20 + 1e13)
 
     if "SWL" not in grid_df:
@@ -257,7 +257,7 @@ def make_qc_gridframe(eclfiles: ecl2df.EclFiles) -> pd.DataFrame:
         logger.warning("Consider adding FILLEPS to the PROPS section")
         grid_df["SWL"] = 0.0
 
-    deck = eclfiles.get_ecldeck()
+    deck = eclfiles.get_deck()
     if "SWATINIT" in deck:
         swatinit_deckdata = deck["SWATINIT"][0][0].get_raw_data_list()
         # This list includes non-active cells, we must map via GLOBAL_INDEX:
@@ -280,12 +280,12 @@ def make_qc_gridframe(eclfiles: ecl2df.EclFiles) -> pd.DataFrame:
             del grid_df["SWATINIT_DECK"]  # This is not needed
 
     # Exposed to issues with endpoint scaling in peculiar decks:
-    satfunc_df = ecl2df.satfunc.df(eclfiles)
+    satfunc_df = res2df.satfunc.df(eclfiles)
 
     # Merge in the input pcmax pr. satnum for each cell:
     grid_df = merge_pc_max(grid_df, satfunc_df)
 
-    grid_df = merge_equil(grid_df, ecl2df.equil.df(eclfiles, keywords=["EQUIL"]))
+    grid_df = merge_equil(grid_df, res2df.equil.df(eclfiles, keywords=["EQUIL"]))
 
     grid_df = augment_grid_frame_qc_vectors(grid_df)
 
@@ -587,7 +587,7 @@ def compute_pc(qc_frame: pd.DataFrame, satfunc_df: pd.DataFrame) -> pd.Series:
     return p_cap
 
 
-def ppcwmax_gridvector(eclfiles: ecl2df.EclFiles) -> pd.Series:
+def ppcwmax_gridvector(eclfiles: res2df.ResdataFiles) -> pd.Series:
     """Generate a vector of PPCWMAX data pr cell
 
     PPCWMAX is pr. SATNUM in the input deck
@@ -596,11 +596,11 @@ def ppcwmax_gridvector(eclfiles: ecl2df.EclFiles) -> pd.Series:
         eclfiles
 
     Returns:
-        pd.Series, indexed according to ecl2df.grid.df(eclfiles)
+        pd.Series, indexed according to res2df.grid.df(eclfiles)
     """
 
-    satnum_df = ecl2df.grid.df(eclfiles, vectors="SATNUM")
-    deck = eclfiles.get_ecldeck()
+    satnum_df = res2df.grid.df(eclfiles, vectors="SATNUM")
+    deck = eclfiles.get_deck()
     for satnum in satnum_df["SATNUM"].unique():
         ppcwmax = deck["PPCWMAX"][satnum - 1][0].get_raw_data_list()[0]
         satnum_df.loc[satnum_df["SATNUM"] == satnum, "PPCWMAX"] = ppcwmax
@@ -615,7 +615,7 @@ def merge_equil(grid_df: pd.DataFrame, equil_df: pd.DataFrame) -> pd.DataFrame:
     assert "Z" in equil_df
     assert "PRESSURE" in equil_df
 
-    # Be compatible with future change in ecl2df:
+    # Be compatible with future change in res2df:
     equil_df.rename({"ACCURACY": "OIP_INIT"}, axis="columns", inplace=True)
 
     contacts = list(set(["OWC", "GOC", "GWC"]).intersection(set(equil_df.columns)))

{subscript-1.1.0 → subscript-1.1.1}/src/subscript/fmuobs/parsers.py

@@ -462,7 +462,11 @@ def resinsight_df2df(ri_dframe: pd.DataFrame) -> pd.DataFrame:
 
     dframe = ri_dframe.copy()
     dframe.rename({"VECTOR": "KEY"}, axis="columns", inplace=True)
-    dframe["LABEL"] = dframe["KEY"].astype(str)  # + "-" + dframe["DATE"].astype(str)
+    dframe["LABEL"] = (
+        dframe["KEY"].astype(str)
+        + "-"
+        + (dframe.groupby("KEY").cumcount() + 1).astype(str)
+    )
     dframe["CLASS"] = "SUMMARY_OBSERVATION"
     if "DATE" in dframe:
         dframe["DATE"] = pd.to_datetime(dframe["DATE"])

{subscript-1.1.0 → subscript-1.1.1}/src/subscript/interp_relperm/interp_relperm.py

@@ -11,7 +11,7 @@ import pyscal
 import yaml
 from configsuite import MetaKeys as MK  # lgtm [py/import-and-import-from]
 from configsuite import types  # lgtm [py/import-and-import-from]
-from ecl2df import satfunc
+from res2df import satfunc
 
 import subscript
 
@@ -397,10 +397,10 @@ def main() -> None:
 
     logger.setLevel(logging.INFO)
 
-    # Mute expected warnings from ecl2df.inferdims, we get these
+    # Mute expected warnings from res2df.inferdims, we get these
     # because we don't tell the module how many SATNUMs there are in
     # input files, which is slightly fragile for opm to parse.
-    logging.getLogger("ecl2df.inferdims").setLevel(logging.ERROR)
+    logging.getLogger("res2df.inferdims").setLevel(logging.ERROR)
 
     # parse the config file
     if not Path(args.configfile).exists():

{subscript-1.1.0 → subscript-1.1.1}/src/subscript/presentvalue/presentvalue.py

@@ -5,9 +5,9 @@ import logging
 from pathlib import Path
 from typing import Dict, Optional
 
-import ecl2df
 import numpy as np
 import pandas as pd
+import res2df
 import scipy.optimize
 
 from subscript import __version__, getLogger
@@ -422,8 +422,8 @@ def get_yearly_summary(
         vec.split(":")[0].endswith("T") for vec in [oilvector, gasvector, gasinjvector]
     ):
         raise ValueError("Only cumulative Eclipse vectors can be used")
-    eclfiles = ecl2df.EclFiles(eclfile)
-    sum_df = ecl2df.summary.df(
+    eclfiles = res2df.ResdataFiles(eclfile)
+    sum_df = res2df.summary.df(
         eclfiles, column_keys=[oilvector, gasvector, gasinjvector], time_index="yearly"
     )
     sum_df.rename(

{subscript-1.1.0 → subscript-1.1.1}/src/subscript/prtvol2csv/prtvol2csv.py

@@ -7,8 +7,8 @@ import warnings
 from pathlib import Path
 from typing import Optional
 
-import ecl2df
 import pandas as pd
+import res2df
 from fmu.tools.fipmapper.fipmapper import FipMapper
 
 from subscript import __version__, getLogger
@@ -162,7 +162,7 @@ def currently_in_place_from_prt(
 ) -> pd.DataFrame:
     """Extracts currently-in-place volumes from a PRT file
 
-    This function uses ecl2df.fipreports, and slices its
+    This function uses res2df.fipreports, and slices its
     output for the purpose here.
 
     Args:
@@ -174,7 +174,7 @@ def currently_in_place_from_prt(
     Returns:
         pd.DataFrame
     """
-    inplace_df = ecl2df.fipreports.df(prt_file, fipname=fipname)
+    inplace_df = res2df.fipreports.df(prt_file, fipname=fipname)
 
     available_dates = inplace_df.sort_values("DATE")["DATE"].unique()
     if date is None or date == "first":

{subscript-1.1.0 → subscript-1.1.1}/src/subscript/sector2fluxnum/completions.py

@@ -1,4 +1,4 @@
-from ecl2df import EclFiles, compdat
+from res2df import ResdataFiles, compdat
 
 
 def get_completion_list(ecl_data_file_name):
@@ -14,7 +14,7 @@ def get_completion_list(ecl_data_file_name):
     List of completions associated to well names
     """
 
-    ecl_file = EclFiles(ecl_data_file_name)
+    ecl_file = ResdataFiles(ecl_data_file_name)
     compdat_df = compdat.df(ecl_file)
 
     # Convert from ECL index

{subscript-1.1.0 → subscript-1.1.1}/src/subscript/version.py

@@ -12,5 +12,5 @@ __version__: str
 __version_tuple__: VERSION_TUPLE
 version_tuple: VERSION_TUPLE
 
-__version__ = version = '1.1.0'
-__version_tuple__ = version_tuple = (1, 1, 0)
+__version__ = version = '1.1.1'
+__version_tuple__ = version_tuple = (1, 1, 1)

{subscript-1.1.0 → subscript-1.1.1}/src/subscript.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: subscript
-Version: 1.1.0
+Version: 1.1.1
 Summary: Equinor's collection of subsurface reservoir modelling scripts
 Author-email: Equinor <rnyb@equinor.com>
 License:                     GNU GENERAL PUBLIC LICENSE
@@ -699,7 +699,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: configsuite
 Requires-Dist: resdata
-Requires-Dist: ecl2df
+Requires-Dist: res2df
 Requires-Dist: ert>=2.38.0b7
 Requires-Dist: fmu-tools
 Requires-Dist: matplotlib

{subscript-1.1.0 → subscript-1.1.1}/src/subscript.egg-info/SOURCES.txt

@@ -26,7 +26,6 @@ docs/_templates/layout.html
 docs/scripts/bjobsusers.rst
 docs/scripts/casegen_upcars.rst
 docs/scripts/check_swatinit.rst
-docs/scripts/co2_containment.rst
 docs/scripts/convert_grid_format.rst
 docs/scripts/csv2ofmvol.rst
 docs/scripts/csv_merge.rst
@@ -62,7 +61,6 @@ docs/scripts/images/Workflow_sector2fluxnum.png
 docs/scripts/images/casegen_upcars_geometry.png
 docs/scripts/images/check_swatinit_scatter.png
 docs/scripts/images/check_swatinit_volplot.png
-docs/scripts/images/co2_containment_A.png
 docs/scripts/images/ecl-swat-initialization.png
 docs/scripts/images/make_check_swatinit_images.sh
 docs/scripts/images/resinsight_wells_project_example.png
@@ -86,10 +84,6 @@ src/subscript/check_swatinit/check_swatinit.py
 src/subscript/check_swatinit/constants.py
 src/subscript/check_swatinit/pillarmodel.py
 src/subscript/check_swatinit/plotter.py
-src/subscript/co2_containment/__init__.py
-src/subscript/co2_containment/calculate.py
-src/subscript/co2_containment/co2_calculation.py
-src/subscript/co2_containment/co2_containment.py
 src/subscript/config_jobs/CHECK_SWATINIT
 src/subscript/config_jobs/CSV2OFMVOL
 src/subscript/config_jobs/CSV_STACK
@@ -183,8 +177,6 @@ tests/test_bjobsusers.py
 tests/test_casegen_upcars.py
 tests/test_check_swatinit.py
 tests/test_check_swatinit_simulators.py
-tests/test_co2_calculate.py
-tests/test_co2_containment.py
 tests/test_convert_grid_format.py
 tests/test_csv2ofmvol.py
 tests/test_csv_merge.py

{subscript-1.1.0 → subscript-1.1.1}/src/subscript.egg-info/entry_points.txt

@@ -2,7 +2,6 @@
 bjobsusers = subscript.bjobsusers.bjobsusers:main
 casegen_upcars = subscript.casegen_upcars.casegen_upcars:main
 check_swatinit = subscript.check_swatinit.check_swatinit:main
-co2_containment = subscript.co2_containment.co2_containment:main
 convert_grid_format = subscript.convert_grid_format.convert_grid_format:main
 csv2ofmvol = subscript.csv2ofmvol.csv2ofmvol:main
 csv_merge = subscript.csv_merge.csv_merge:main

{subscript-1.1.0 → subscript-1.1.1}/src/subscript.egg-info/requires.txt

@@ -1,6 +1,6 @@
 configsuite
 resdata
-ecl2df
+res2df
 ert>=2.38.0b7
 fmu-tools
 matplotlib

{subscript-1.1.0 → subscript-1.1.1}/tests/test_check_swatinit_simulators.py

@@ -13,10 +13,10 @@ import subprocess
 import time
 from pathlib import Path
 
-import ecl2df
 import numpy as np
 import pandas as pd
 import pytest
+import res2df
 
 from subscript.check_swatinit.check_swatinit import (
     __HC_BELOW_FWL__,
@@ -85,7 +85,7 @@ def run_reservoir_simulator(simulator, resmodel, perform_qc=True):
         raise AssertionError(f"reservoir simulator failed in {os.getcwd()}")
 
     if perform_qc:
-        return make_qc_gridframe(ecl2df.EclFiles("FOO.DATA"))
+        return make_qc_gridframe(res2df.ResdataFiles("FOO.DATA"))
     return None
 
 
@@ -494,7 +494,7 @@ def test_swatinit_less_than_1_below_contact(simulator, tmp_path):
         assert np.isclose(qc_frame["PC"], 0)
     else:
         # E100 will not report a PPCW in this case, libecl gives -1e20,
-        # which becomes a NaN through ecl2df and then NaN columns are dropped.
+        # which becomes a NaN through res2df and then NaN columns are dropped.
         if "PPCW" in qc_frame:
             assert pd.isnull(qc_frame["PPCW"][0])
         if "PC_SCALING" in qc_frame:

{subscript-1.1.0 → subscript-1.1.1}/tests/test_interp_relperm.py

@@ -6,9 +6,9 @@ import configsuite
 import pandas as pd
 import pytest
 import yaml
-from ecl2df import satfunc
 from pyscal import PyscalFactory
 from pyscal.utils.testing import sat_table_str_ok
+from res2df import satfunc
 
 from subscript.interp_relperm import interp_relperm
 
@@ -201,7 +201,7 @@ def test_garbled_base_input(tmp_path):
 
 def test_parse_satfunc_files():
     """Test that tables in Eclipse format can be converted
-    into dataframes (using ecl2df)"""
+    into dataframes (using res2df)"""
     swoffn = TESTDATA / "swof_base.inc"
     sgoffn = TESTDATA / "sgof_base.inc"
 

{subscript-1.1.0 → subscript-1.1.1}/tests/test_presentvalue.py

@@ -3,10 +3,10 @@ import shutil
 import subprocess
 from pathlib import Path
 
-import ecl2df
 import numpy as np
 import pandas as pd
 import pytest
+import res2df
 from resdata.summary import Summary
 
 from subscript.presentvalue import presentvalue
@@ -328,7 +328,7 @@ def test_no_gasinj(tmp_path):
     )
     smry["DATE"] = pd.to_datetime(smry["DATE"])
     smry.set_index("DATE")
-    eclsum = ecl2df.summary.df2eclsum(smry, "NOGASINJ")
+    eclsum = res2df.summary.df2ressum(smry, "NOGASINJ")
     Summary.fwrite(eclsum)
     econ_df = presentvalue.prepare_econ_table(
         oilprice=100, gasprice=0, usdtonok=10, discountrate=0
@@ -353,7 +353,7 @@ def test_no_gas(tmp_path):
     )
     smry["DATE"] = pd.to_datetime(smry["DATE"])
     smry.set_index("DATE")
-    eclsum = ecl2df.summary.df2eclsum(smry, "NOGAS")
+    eclsum = res2df.summary.df2ressum(smry, "NOGAS")
     Summary.fwrite(eclsum)
     econ_df = presentvalue.prepare_econ_table(
         oilprice=100, gasprice=0, usdtonok=10, discountrate=0
@@ -378,7 +378,7 @@ def test_no_oil(tmp_path):
     )
     smry["DATE"] = pd.to_datetime(smry["DATE"])
     smry.set_index("DATE")
-    eclsum = ecl2df.summary.df2eclsum(smry, "NOOIL")
+    eclsum = res2df.summary.df2ressum(smry, "NOOIL")
     Summary.fwrite(eclsum)
     econ_df = presentvalue.prepare_econ_table(
         oilprice=0, gasprice=10, usdtonok=10, discountrate=0

{subscript-1.1.0 → subscript-1.1.1}/tests/testdata_fmuobs/ert-doc.csv

@@ -1,5 +1,6 @@
 CLASS,LABEL,VALUE,ERROR,DATE,KEY,RESTART,DAYS,OBS,FIELD,I,J,K,SOURCE,DATA,OBS_FILE,INDEX_LIST,ERROR_MODE,ERROR_MIN,SEGMENT,START,STOP
 SUMMARY_OBSERVATION,SEP_TEST_2005,100.0,5.0,2005-08-21,GOPR:BRENT,,,,,,,,,,,,,,,,
+SUMMARY_OBSERVATION,SEP_TEST_2006,100.0,5.0,2006-08-21,GOPR:BRENT,,,,,,,,,,,,,,,,
 SUMMARY_OBSERVATION,SEP_TEST_RST_2005,100.0,5.0,,GOPR:BRENT,42.0,,,,,,,,,,,,,,,
 SUMMARY_OBSERVATION,SEP_TEST_2008,213.0,10.0,,GOPR:NESS,,911.0,,,,,,,,,,,,,,
 BLOCK_OBSERVATION,RFT_2006,100.0,5.0,2006-10-22,,,,P1,PRESSURE,1.0,1.0,1.0,,,,,,,,,

{subscript-1.1.0 → subscript-1.1.1}/tests/testdata_fmuobs/ert-doc.obs

@@ -1,4 +1,4 @@
- -- These observation data are copied from the ERT docs,
+ -- These observation data are mainly copied from the ERT docs,
  -- https://github.com/equinor/ert/blob/master/docs/rst/manual/reference/configuration/observations.rst
 
  SUMMARY_OBSERVATION SEP_TEST_2005
@@ -8,6 +8,14 @@
     DATE  = 21/08/2005;
     KEY   = GOPR:BRENT;
  };
+ -- Duplicate key, but unique label and date.
+ SUMMARY_OBSERVATION SEP_TEST_2006
+ {
+    VALUE = 100.0;
+    ERROR =     5;
+    DATE  = 21/08/2006;
+    KEY   = GOPR:BRENT;
+ };
  
  -- Giving the observation time in terms of restart number.
  SUMMARY_OBSERVATION SEP_TEST_RST_2005

{subscript-1.1.0 → subscript-1.1.1}/tests/testdata_fmuobs/ert-doc.yml

@@ -53,6 +53,10 @@ smry:
     error: 5.0
     label: SEP_TEST_2005
     value: 100.0
+  - date: '2006-08-21'
+    error: 5.0
+    label: SEP_TEST_2006
+    value: 100.0
   - error: 5.0
     label: SEP_TEST_RST_2005
     restart: 42.0

{subscript-1.1.0 → subscript-1.1.1}/tests/testdata_fmuobs/ri-obs.csv

@@ -1,2 +1,3 @@
 DATE;VECTOR;VALUE;ERROR
 2005-08-21;GOPR:BRENT;100.0;5.0
+2006-08-21;GOPR:BRENT;100.0;5.0

subscript-1.1.0/docs/scripts/co2_containment.rst

@@ -1,71 +0,0 @@
-
-CO2_CONTAINMENT
-===============
-
-.. argparse::
-   :module: subscript.co2_containment.co2_containment
-   :func: get_parser
-   :prog: co2_containment
-
-Calculates the amount of CO\ :sub:`2` inside and outside a given perimeter, and separates the result per formation and phase (gas/dissolved). Output is a table on CSV format.
-
-The most common use of the script is to calculate CO\ :sub:`2` mass. Options for calculation type input:
-
-* "mass": CO\ :sub:`2` mass (kg), the default option
-* "cell_volume": CO\ :sub:`2` volume (m\ :sup:`3`), a simple calculation finding the grid cells with some CO\ :sub:`2` and summing the volume of those cells
-* "actual_volume": CO\ :sub:`2` volume (m\ :sup:`3`), an attempt to calculate a more precise representative volume of CO\ :sub:`2`
-
-CSV file example
-----------------------------
-Example of how the output CSV file is structured:
-
-.. list-table:: CSV file of CO2 mass (kg)
-   :widths: 25 25 25 25 25 25 25 25 25 25
-   :header-rows: 1
-
-   * - date
-     - total
-     - total_contained
-     - total_outside
-     - total_hazardous
-     - total_gas
-     - total_aqueous
-     - gas_contained
-     - aqueous_contained
-     - . . .
-   * - 2020-01-01
-     -
-     -
-     -
-     -
-     -
-     -
-     -
-     -
-     -
-   * - 2060-01-01
-     -
-     -
-     -
-     -
-     -
-     -
-     -
-     -
-     -
-   * - 2100-01-01
-     -
-     -
-     -
-     -
-     -
-     -
-     -
-     -
-     -
-
-.. figure:: images/co2_containment_A.png
-   :align: center
-   :width: 40%
-
-   Example plot of CO\ :sub:`2` mass made from a CO\ :sub:`2` containment output CSV file