allow ignoring parameters.dat

This can be useful with runs of StagYY predating v1.2.6 for which
parameters.dat contained values polluted by `check_*` subroutines.

Author: amorison

stagpy/parfile.py

@@ -46,14 +46,15 @@ def _update(self, par_new: StagyyPar) -> None:
                 self.nml[section] = content
 
     @staticmethod
-    def from_main_par(parfile: Path) -> StagyyPar:
+    def from_main_par(parfile: Path, read_parameters_dat: bool = True) -> StagyyPar:
         """Read StagYY namelist `parfile`.
 
         The namelist is populated in order with:
 
         - `par_name_defaultparameters` if it is defined in `parfile`;
         - `par_file` itself;
-        - `parameters.dat` if it can be found in the StagYY output directories.
+        - `parameters.dat` if it can be found in the StagYY output directories
+          and `read_parameters_dat` is `True`.
         """
         par_main = StagyyPar._from_file(parfile)
         if "default_parameters_parfile" in par_main.nml:
@@ -66,12 +67,13 @@ def from_main_par(parfile: Path) -> StagyyPar:
             par_dflt._update(par_main)
             par_main = StagyyPar(nml=par_dflt.nml, root=par_main.root)
 
-        outfile = par_main.legacy_output("_parameters.dat")
-        if outfile.is_file():
-            par_main._update(StagyyPar._from_file(outfile))
-        outfile = par_main.h5_output("parameters.dat")
-        if outfile.is_file():
-            par_main._update(StagyyPar._from_file(outfile))
+        if read_parameters_dat:
+            outfile = par_main.legacy_output("_parameters.dat")
+            if outfile.is_file():
+                par_main._update(StagyyPar._from_file(outfile))
+            outfile = par_main.h5_output("parameters.dat")
+            if outfile.is_file():
+                par_main._update(StagyyPar._from_file(outfile))
         return par_main
 
     def get(self, section: str, option: str, default: T) -> T:

stagpy/stagyydata.py

@@ -651,21 +651,27 @@ class StagyyData:
             directory containing the par file, or the path of the par file. If
             the path given is a directory, the path of the par file is assumed
             to be path/par.
+        read_parameters_dat: read `parameters.dat` file produced by StagYY. This
+            flag can be switched off to ignore this file. This is intended for
+            runs of StagYY that predate version 1.2.6 for which the
+            `parameters.dat` file contained some values affected by internal
+            logic.
 
     Attributes:
         steps (Steps): collection of time steps.
         snaps (Snaps): collection of snapshots.
         refstate (Refstate): reference state profiles.
     """
 
-    def __init__(self, path: PathLike):
+    def __init__(self, path: PathLike, read_parameters_dat: bool = True):
         self._parpath = Path(path)
         if not self._parpath.is_file():
             self._parpath /= "par"
         self.refstate = Refstate(self)
         self.tseries = Tseries(self)
         self.steps = Steps(self)
         self.snaps = Snaps(self)
+        self._read_parameters_dat = read_parameters_dat
         self._nfields_max: Optional[int] = 50
         # list of (istep, field_name) in memory
         self._collected_fields: list[tuple[int, str]] = []
@@ -723,7 +729,7 @@ def _traxmf(self) -> TracersXmf:
     @cached_property
     def par(self) -> StagyyPar:
         """Content of par file."""
-        return StagyyPar.from_main_par(self.parpath)
+        return StagyyPar.from_main_par(self.parpath, self._read_parameters_dat)
 
     @cached_property
     def _rprof_and_times(self) -> tuple[dict[int, DataFrame], Optional[DataFrame]]: