smashbox 1.0__py2.py3-none-any.whl

smashbox/init/smashbox.py

@@ -0,0 +1,186 @@
+from smashbox.init import param
+from smashbox.model import model
+from smashbox.stats import mystats
+from smashbox.plot import myplot
+from smashbox.init import multimodel_statistics
+import smashbox
+
+import os
+import shutil
+import copy
+
+
+class SmashBox:
+    """
+    Main class which store main parameters 'myparam' and functions to create or delete
+     models.
+    """
+
+    def __init__(self):
+
+        if not os.path.exists(
+            os.path.join(os.path.expanduser("~"), ".smashbox", "asset")
+        ):
+            shutil.copytree(
+                os.path.join(smashbox.__path__[0], "asset"),
+                os.path.join(os.path.expanduser("~"), ".smashbox", "asset"),
+            )
+
+        self.myparam = param.param()
+        if os.path.exists(
+            os.path.join(os.path.expanduser("~"), ".smashbox", "param.yaml")
+        ):
+            self.myparam.load_param(
+                os.path.join(os.path.expanduser("~"), ".smashbox", "default_param.yaml")
+            )
+        else:
+            self.myparam.write_param(
+                os.path.join(os.path.expanduser("~"), ".smashbox", "default_param.yaml")
+            )
+
+    def help(self):
+        """Display help..."""
+
+        print("! Welcome to SmashBox !")
+        print(
+            "First of all, you must configure main parameters stored in 'myparam' attribute."
+        )
+        print(
+            " - self.myparam.list_param() : list all parameters to configure in self.myparam.param."
+        )
+        print(" - self.myparam.set_param(attr, value) : set value to attribute attr.")
+        print(" - self.myparam.get_param(attr) : get the value of attribute attr.")
+        print(" - self.myparam.list_asset_files() : list data available with SmashBox.")
+        print(" - self.myparam.param : attribute which contains all parameters.")
+        print("")
+        print("When ready, you will able to create a new model attribute:")
+        print(" - self.newmodel('mymodel')")
+        print("")
+        print(
+            "After the model 'mymodel' has been created, you can adjust the model setup 'self.mymodel.mysetup':"
+        )
+        print(" - self.mymodel.mysetup.setup: dictionnary which contain the setup")
+        print(
+            " - self.mymodel.mysetup.list_available_setup(): list preconfigured and ready to use setup in SmashBox"
+        )
+        print(
+            " - self.mymodel.mysetup.update_setup(dict): update the smash setup with the input dictionary dict."
+        )
+        print("")
+        print(
+            "When ready, you will be able to create the mesh, the Smash model and run a simulation:"
+        )
+        print(" - self.mymodel.make_mesh()")
+        print(" - self.mymodel.make_model()")
+
+    def newmodel(self, name="mymodel"):
+        """
+        Create a new model attribute. This attribute will handle meshing, hydrological modelisation, plot and stattistics.
+
+        Parameters
+        ----------
+
+        name : str
+            The name of the attribute.
+
+        Examples
+        --------
+
+        >>> es=smashbox.SmashBox()
+        >>> sb.newmodel("RealCollobrier")
+
+        """
+        if not hasattr(self, name):
+
+            setattr(self, name, model.model(self.myparam))
+
+        else:
+            raise ValueError(
+                f"Error: Cannot create model '{name}', model attribute '{name}' already exist"
+            )
+
+        if not hasattr(self, "multimodel_statistics"):
+
+            setattr(
+                self, "multimodel_statistics", multimodel_statistics.multimodel_statistics(self)
+            )
+
+    def delmodel(self, modelname):
+        """
+        Delete a model attribute.
+
+        Parameters
+        ----------
+
+        modelname : str
+            The name of the attribute to delete.
+
+        Examples
+        --------
+
+        >>> es=smashbox.SmashBox()
+        >>> sb.newmodel("RealCollobrier")
+        >>> sb.delmodel("RealCollobrier")
+
+        """
+        if hasattr(self, modelname) and isinstance(getattr(self, modelname), model.model):
+            delattr(self, modelname)
+
+        else:
+
+            raise ValueError(f"Error: {modelname} is not a valid model name.")
+
+    def copymodel(self, modelsource, modelname):
+        """
+        Copy a model contener
+
+        Parameters
+        ----------
+
+        modelsource : str
+            The name of the source model attribute
+        modelname : str
+            The name of the new model attribute.
+
+        Examples
+        --------
+
+        >>> es=smashbox.SmashBox()
+        >>> sb.newmodel("RealCollobrier")
+        >>> sb.copymodel("RealCollobrier", RealCollobrier2")
+        """
+        if not hasattr(self, modelsource):
+            raise ValueError(f"Error: Source model '{modelsource}' does not exist")
+
+        if not hasattr(self, modelname):
+
+            self.newmodel(modelname)
+
+            source = getattr(self, modelsource)
+            destination = getattr(self, modelname)
+
+            setattr(
+                destination,
+                "_myparam",
+                copy.deepcopy(getattr(source, "_myparam")),
+            )
+            setattr(destination, "mymesh", copy.deepcopy(getattr(source, "mymesh")))
+            setattr(destination, "mysetup", copy.deepcopy(getattr(source, "mysetup")))
+
+        else:
+            raise ValueError(
+                f"Error: Cannot copy model '{modelsource}', model attribute '{modelname}' already exist"
+            )
+
+        # get new model object
+        # mynewmodel = getattr(self, modelname)
+
+        # reset attributes
+        # mynewmodel.mysmashmodel = None
+        # mynewmodel.extra_smash_results = None
+        # mynewmodel._fstates = None
+        # mynewmodel._istates = None
+        # mynewmodel._myatmos_data_connector = None
+        # mynewmodel.warmup_model = None
+        # mynewmodel.mystats = mystats.mystats(self)
+        # mynewmodel.myplot = myplot.myplot(self)

smashbox/model/__init__.py

@@ -0,0 +1 @@
+