smashbox 1.0__tar.gz → 1.1__tar.gz

{smashbox-1.0 → smashbox-1.1}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: smashbox
-Version: 1.0
-Summary: A python library developed by Hydris-hydrologie (https://www.hydris-hydrologie.fr/) to provide an technical environment for performing hydrological simulation with Smash. This library is preloaded with data (France only), comes with preconfigured setup, own some extra features such as the in-memory atmospheric data connector, has statistical and plot capabilities. Plot and stats functions can be used as a separate module with your own Smash model object.
-Project-URL: Homepage, https://codeberg.org/maximejay/easysmash
-Project-URL: Issues, https://codeberg.org/maximejay/easysmash/issues
+Version: 1.1
+Summary: A python library developed by Hydris-hydrologie (https://www.hydris-hydrologie.fr/) and INRAE to provide an technical environment for performing hydrological simulation with Smash. This library is preloaded with data (France only), comes with preconfigured setup, own some extra features such as the in-memory atmospheric data connector, has statistical and plot capabilities. Plot and stats functions can be used as a separate module with your own Smash model object.
+Project-URL: Homepage, https://codeberg.org/maximejay/smashbox
+Project-URL: Issues, https://codeberg.org/maximejay/smashbox/issues
 Author-email: Maxime Jay-Allemand <maxime.jay.allemand@hydris-hydrologie.fr>
 License-File: LICENSE
 Keywords: hydro-smash,plot,smash,statistics

smashbox-1.1/mail_pr/303/251sentation_smashbox.txt

@@ -0,0 +1,17 @@
+Bonjour,
+
+Je vous présente la librairie Python "SmashBox" (anciennement "EasySmash", présentée à la dernière réunion d'équipe). L'objectif de SmashBox est de fournir un environnement de travail simplifié pour Smash afin de gérer des pré et post traitements (maillage, calculs de statistiques et réalisation de graphique). Smashbox intègre des données prêtes à l’emploi (base de données d'exutoires, direction d'écoulement 1km², paramètres issus de la régionalisation nationale de Julie 2025) et des setup pré-configurés pour fonctionner sur les serveurs Rhax.
+L'idée derrière ce module, est de simplifier certaines opérations courantes réalisées avec Smash (telle que les REX), fournir des interfaces vers d'autres outils de calcul (SCHYPRE-Graffas) et de mutualiser progressivement les outils de post-traitements (graphiques, statistiques, etc...).
+
+La librairie s'installe facilement via Pypi (https://pypi.org/project/smashbox/) par la commande :
+pip install smashbox
+
+Remarque importante pour les testeurs : Smashbox fonctionne avec la future version de SMASH 1.2 (qui n'est pas encore sortie). En attendant cette version, vous devez donc installer SMASH manuellement dans votre environnement Python en repartant de la branche "main" : https://github.com/DassHydro/smash.git
+
+Le code est disponible ici: https://codeberg.org/maximejay/smashbox et la documentation complète en ligne est là: https://maximejay.codeberg.page/smashbox.html
+
+Les contributions, rapport de bug, idées, tests en tout genre sont les bienvenus :) Je vous laisse découvrir l'outil via la documentation. Il y a une petite rubrique "tutorial" un peu cachée tout en bas à gauche dans le sommaire qui pourrait vous servir. N'hésitez pas à me contacter si vous souhaitez tester cette librairie et si vous avez des questions !
+
+A bientôt
+
+Maxime

smashbox-1.1/pyproject.toml

@@ -0,0 +1,27 @@
+[build-system]
+requires = ["hatchling >= 1.26"]
+build-backend = "hatchling.build"
+
+[project]
+name = "smashbox"
+version = "1.1"
+authors = [
+  { name="Maxime Jay-Allemand", email="maxime.jay.allemand@hydris-hydrologie.fr" },
+]
+dependencies = [
+  "pyhdf5_handler",
+  "hydro-smash",
+  "matplotlib",
+  "mpld3",
+  "pdoc",
+  "rich",
+  "pyhdf5_handler",
+]
+description = "A python library developed by Hydris-hydrologie (https://www.hydris-hydrologie.fr/) and INRAE to provide an technical environment for performing hydrological simulation with Smash. This library is preloaded with data (France only), comes with preconfigured setup, own some extra features such as the in-memory atmospheric data connector, has statistical and plot capabilities. Plot and stats functions can be used as a separate module with your own Smash model object."
+readme = "README.md"
+license-files = ["LICEN[CS]E*"]
+keywords = ["hydro-smash", "smash", "statistics", "plot"]
+
+[project.urls]
+Homepage = "https://codeberg.org/maximejay/smashbox"
+Issues = "https://codeberg.org/maximejay/smashbox/issues"

{smashbox-1.0 → smashbox-1.1}/smashbox/.spyproject/config/backups/workspace.ini.bak

@@ -4,7 +4,7 @@ save_data_on_exit = True
 save_history = True
 save_non_project_files = False
 project_type = 'empty-project-type'
-recent_files = ['tutorial_report.py', 'init/smashbox.py', 'model/model.py', 'stats/mystats.py', 'init/multimodel_statistics.py', 'stats/stats.py', 'init/param.py', 'test.py', 'test_average_stats.py', 'test_mesh.r', 'test_mesh_from_graffas.py', 'init/__init__.py', 'plot/plot.py']
+recent_files = ['tutorial_report.py', 'init/smashbox.py', 'model/model.py', 'stats/mystats.py', 'init/multimodel_statistics.py', 'stats/stats.py', 'init/param.py', 'test.py', 'test_average_stats.py', 'test_mesh.r', 'test_mesh_from_graffas.py', 'init/__init__.py', 'plot/plot.py', 'tutorial_python.py']
 
 [main]
 version = 0.2.0

{smashbox-1.0 → smashbox-1.1}/smashbox/.spyproject/config/workspace.ini

@@ -4,7 +4,7 @@ save_data_on_exit = True
 save_history = True
 save_non_project_files = False
 project_type = 'empty-project-type'
-recent_files = ['tutorial_report.py', 'init/smashbox.py', 'model/model.py', 'stats/mystats.py', 'init/multimodel_statistics.py', 'stats/stats.py', 'init/param.py', 'test.py', 'test_average_stats.py', 'test_mesh.r', 'test_mesh_from_graffas.py', 'init/__init__.py', 'plot/plot.py']
+recent_files = ['tutorial_report.py', 'init/smashbox.py', 'model/model.py', 'stats/mystats.py', 'init/multimodel_statistics.py', 'stats/stats.py', 'init/param.py', 'test.py', 'test_average_stats.py', 'test_mesh.r', 'test_mesh_from_graffas.py', 'init/__init__.py', 'plot/plot.py', 'tutorial_python.py', 'tools/tools.py', 'model/mesh.py']
 
 [main]
 version = 0.2.0

{smashbox-1.0 → smashbox-1.1}/smashbox/model/model.py

@@ -393,7 +393,13 @@ class model:
         o_setup["read_prcp"] = True
         o_setup["read_pet"] = True
 
-        self.optimize_model = self._model(setup=o_setup, mesh=self.mymesh.mesh)
+        # ~ if hasattr(self, "optimize_model") and self.optimize_model is not None:
+        # ~ previous_optimized_model_rr_parameters = self.optimize_model.rr_parameters.copy()
+
+        if not hasattr(self, "optimize_model") or self.optimize_model is None:
+            self.optimize_model = self._model(setup=o_setup, mesh=self.mymesh.mesh)
+            print(f"</> Getting parameters the default model `mysmashmodel` ...")
+            self.optimize_model.rr_parameters = self.mysmashmodel.rr_parameters.copy()
 
         default_cost_option = {"end_warmup": o_setup["start_time"], "gauge": "all"}
         if cost_options is not None:
@@ -662,7 +668,7 @@ class model:
     def import_parameters(self, model=None):
         """
         Import Geotiff parameter in Smash. This function wrap
-        smash.io.import_parameters(). Path to the parameters is defined in
+        smash.io.read_grid_parameters(). Path to the parameters is defined in
         self._myparam.param.smash_parameters.
 
         Parameter
@@ -691,15 +697,15 @@ class model:
         if model is None:
             model = self.mysmashmodel
 
-        smash.io.import_parameters(
+        smash.io.read_grid_parameters(
             model=model,
-            path_to_parameters=self._myparam.param.smash_parameters,
+            path=self._myparam.param.smash_parameters,
         )
 
     def export_parameters(self, path: os.PathLike = "./output_smash_param"):
         """
         Export Geotiff Smash parameter as Geotiff. This function wrap
-        smash.io.export_parameters().
+        smash.io.save_grid_parameters().
 
         Parameters
         ----------

{smashbox-1.0 → smashbox-1.1}/smashbox/test.py

@@ -4,20 +4,20 @@ if __name__ == "__main__":
 
     from smashbox import tools
 
-    @tools.tools.autocast_args
-    def test(
-        a: int | None = None,
-        b: None | int = None,
-        c: int | None = 1,
-        d: int = 2,
-        e: None = None,
-        f: None | dict | tuple = None,
-        g=1,
-    ):
+    # @tools.tools.autocast_args
+    # def test(
+    #     a: int | None = None,
+    #     b: None | int = None,
+    #     c: int | None = 1,
+    #     d: int = 2,
+    #     e: None = None,
+    #     f: None | dict | tuple = None,
+    #     g=1,
+    # ):
 
-        print(a, b, c, d, e)
+    #     print(a, b, c, d, e)
 
-    test(a=1.0, b=1.0, c=1.0, d=1.0, e=None, f=(2,), g=2)
+    # test(a=1.0, b=1.0, c=1.0, d=1.0, e=None, f=(2,), g=2)
 
     # Main object creation
     sb = smashbox.SmashBox()
@@ -29,20 +29,12 @@ if __name__ == "__main__":
         "outlets_database",
         "/home/maxime/DEV/smashbox/smashbox/asset/outlets/db_stations_example.csv",
     )
-
-    sb.myparam.set_param(
-        "outlets_database_fields",
-        {"coord_x": "X_L93", "coord_y": "Y_L93", "area": "SURF", "id": "ID_HYDRO"},
-    )  # change/update/set the value of the parameter 'outlets_database_fields'.
+    sb.myparam.set_param("outletsID", ["Y4604020"])
 
     sb.myparam.set_param(
         "smash_parameters", "/home/maxime/DEV/smashbox/smashbox/asset/params"
     )  # change the value of myparam used byRealCollobrier
 
-    # Read/write param
-    # sb.myparam.write_param("param.yaml") #write smashbox param
-    sb.myparam.load_param("param.yaml")  # load smashbox param
-
     # New model creation
     sb.newmodel(
         "RealCollobrier"
@@ -50,58 +42,62 @@ if __name__ == "__main__":
 
     # create an second model with different parameters
     sb.myparam.param.setup_file = "setup_rhax_gr5_dt3600.yaml"
-    sb.myparam.set_param(
-        "outlets_database_fields",
-        {"coord_x": "X", "coord_y": "Y", "area": "area", "id": "Nom"},
-    )  # change/update/set the value of the parameter 'outlets_database_fields'.
-    sb.newmodel(
-        "Lez"
-    )  # create a new model named RealCollobrier and copy the previous parameters used for mymodel1 (default behaviour, but it can turned off)
-
-    # Remove a model
-    sb.delmodel("Lez")
 
     # Param associated to the model (hidden) has been copied
     sb.RealCollobrier._myparam.list_param()  # Notice that myparam is also stored in each model object. So you can access to the model param inside the model attribute.
-    sb.RealCollobrier._myparam.param.epsg
 
     # Setup utilities
     sb.RealCollobrier.mysetup.setup  # print the setup to the screen
-    # sb.RealCollobrier.mysetup.write_setup("setup.yaml") #Write the Smash setup
-    sb.RealCollobrier.mysetup.load_setup("setup.yaml")  # Read a custom Smash setup
     sb.RealCollobrier.mysetup.update_setup(
         {
             "hydrological_module": "gr4",
-            "end_time": "2014-01-01 12:00",
+            "end_time": "2014-02-01 12:00",
             "start_time": "2014-01-01 01:00",
             "pet_directory": "/home/maxime/DATA/ETP-SFR-FRA-INTERA_L93",
             "prcp_directory": "/home/maxime/DATA/PLUIE",
-            "qobs_directory": "/home/maxime/DATA/QOBS",
+            "qobs_directory": "/home/maxime/DATA/QOBS_60min",
         }
     )  # Change value of the Smash setup
     sb.RealCollobrier.mysetup.setup  # print the setup to the screen
 
-    # Mesh utilities (hidden)
-    sb.RealCollobrier.mymesh.mesh  # print the mesh to the screen
-    sb.RealCollobrier.mymesh.make_mesh(
-        sb.RealCollobrier._myparam.param
-    )  # Undirect method to build mesh, depend on myparam (unrecomended)
-    sb.RealCollobrier.mymesh.mesh
-    sb.RealCollobrier.mymesh.write_mesh("mesh.hdf5")
-    sb.RealCollobrier.mymesh.load_mesh("mesh.hdf5")
-    sb.RealCollobrier.mymesh.mesh  # print the mesh to the screen
-
-    # Model utilities
-    sb.RealCollobrier.make_mesh()  # direct method to build the mesh (recommended)
-    sb.RealCollobrier.build_model()  # build the model with smash.Model()
-    sb.RealCollobrier.load_smashparam()  # extract the smash parameter from a parameters set and fill the attribute mysmashparameter
-    sb.RealCollobrier.write_smashparam(
-        "smashparam.hdf5"
-    )  # write the extracted parameter in an hdf5 database
-    sb.RealCollobrier.write_smashparam_to_geotiff("geotiff_smashparam")
-    sb.RealCollobrier.make_model(
-        run=True
-    )  # direct build, extract param and run (default is True). Use option run=False to only build the model and extract parameter
+    sb.RealCollobrier.generate_mesh()  # direct method to build the mesh (recommended)
+
+    sb.RealCollobrier.model()
+
+    sb.RealCollobrier.mysmashmodel.set_rr_parameters("cp", 500.0)
+    sb.RealCollobrier.mysmashmodel.set_rr_parameters("ct", 200.0)
+    sb.RealCollobrier.mysmashmodel.set_rr_parameters("llr", 50.0)
+    sb.RealCollobrier.mysmashmodel.set_rr_parameters("kexc", 0.0)
+
+    sb.RealCollobrier.optimize(
+        cost_options={"end_warmup": "2014-01-10 01:00", "gauge": "all"},
+        mapping="uniform",
+        optimizer="sbs",
+        optimize_options={
+            "bounds": {
+                "cp": [1, 1000],
+                "ct": [1, 1000],
+                "kexc": [-50, 50],
+                "llr": [1, 1000],
+            },
+            "termination_crit": {"maxiter": 10},
+        },
+    )
+
+    sb.RealCollobrier.optimize(
+        cost_options={"end_warmup": "2014-01-10 01:00", "gauge": "all"},
+        mapping="distributed",
+        optimizer="lbfgsb",
+        optimize_options={
+            "bounds": {
+                "cp": [1, 1000],
+                "ct": [1, 1000],
+                "kexc": [-50, 50],
+                "llr": [1, 1000],
+            },
+            "termination_crit": {"maxiter": 10},
+        },
+    )
 
     # Stat utilities
 

{smashbox-1.0 → smashbox-1.1}/smashbox/tools/tools.py

@@ -230,7 +230,7 @@ def check_asset_path(asset_dir: str = "", path: None | os.PathLike = None):
         if len(matched_file) == 0:
             raise ValueError(
                 f"'{path}' is not a valid {asset_dir} filename."
-                "Choice are: {os.listdir(mypath)}"
+                f"Choice are: {os.listdir(mypath)}"
             )
         else:
             path = matched_file[0]

smashbox-1.0/mail_pr/303/251sentation_smashbox.txt

@@ -1,16 +0,0 @@
-Bonjour,
-
-Je vous présente la librairie Python "SmashBox" (anciennement "EasySmash", présenté à la dernière réunion d'équipe). L'objectif de SmashBox est de fournir un environnement de travail simplifié pour Smash afin de gérer des pré et post traitements (maillage, calculs de statistique et réalisation de graphique). Smashbox intègre des données prêtes à l’emploi (base de données d'exutoires, direction d'écoulement 1km², paramètres issus de la régio nationale de Julie) et des setup pré-configurés pour fonctionner sur les serveurs Rhax.
-L'idée derrière ce module, est de simplifier certaines opérations courantes réalisées avec Smash (telle que les REX), fournir des interface vers d'autres outils de calcul (SCHYPRE-Graffas) et de mutualiser progressivement les outils de post-traitements (graphiques, statistiques, etc...).
-
-Le code est disponible ici: https://codeberg.org/maximejay/smashbox et la documentation est là: https://maximejay.codeberg.page/smashbox.html
-
-Les contributions, rapport de bug, idées, tests en tout genre sont les bienvenus :) Je vous laisse découvrir l'outil via la documentation. Il y a une petite rubrique "tutorial" un peu caché tout en bas à gauche dans le sommaire qui pourrait vous servir. N'hésitez pas à me contacter si vous souhaitez tester cette librairie et si vous avez des questions !
-
-A bientôt
-
-Maxime
-
-
-
-

smashbox-1.0/pyproject.toml

@@ -1,27 +0,0 @@
-[build-system]
-requires = ["hatchling >= 1.26"]
-build-backend = "hatchling.build"
-
-[project]
-name = "smashbox"
-version = "1.0"
-authors = [
-  { name="Maxime Jay-Allemand", email="maxime.jay.allemand@hydris-hydrologie.fr" },
-]
-dependencies = [
-  "pyhdf5_handler",
-  "hydro-smash",
-  "matplotlib",
-  "mpld3",
-  "pdoc",
-  "rich",
-  "pyhdf5_handler",
-]
-description = "A python library developed by Hydris-hydrologie (https://www.hydris-hydrologie.fr/) to provide an technical environment for performing hydrological simulation with Smash. This library is preloaded with data (France only), comes with preconfigured setup, own some extra features such as the in-memory atmospheric data connector, has statistical and plot capabilities. Plot and stats functions can be used as a separate module with your own Smash model object."
-readme = "README.md"
-license-files = ["LICEN[CS]E*"]
-keywords = ["hydro-smash", "smash", "statistics", "plot"]
-
-[project.urls]
-Homepage = "https://codeberg.org/maximejay/easysmash"
-Issues = "https://codeberg.org/maximejay/easysmash/issues"