smashbox 1.0__py2.py3-none-any.whl

smashbox/model/setup.py

@@ -0,0 +1,109 @@
+import yaml
+import os
+from smashbox.tools.tools import check_asset_path, print_tree
+from smashbox.init import param
+
+
+class setup:
+    """The class setup stores the Smash model setup and functions to manipulate
+    the setup"""
+
+    def __init__(self, param: param = None):
+
+        self.setup = None
+        """The smash model setup"""
+
+        self._setup_file = None
+        """The preconfigured setup file to use."""
+
+        self._param = param
+        """The easy smash parameters src.param.param"""
+
+        if param.setup_file is not None:
+            self._setup_file = param.setup_file
+        else:
+            self._setup_file = os.path.join(
+                self._param.asset_dir, "setup", "setup_rhax_gr4_dt3600.yaml"
+            )
+
+        self.load_setup(self._setup_file)
+
+    @property
+    def setup_file(self):
+        """The current selected setup file in the preconfigured list."""
+        return self._setup_file
+
+    @setup_file.setter
+    def setup_file(self, value: os.PathLike):
+        """Set and load the a preconfigured setup file."""
+        self._setup_file = check_asset_path("setup", value)
+        self.load_setup(self._setup_file)
+
+    def list_available_setup(self):
+        """List available preconfigured setup"""
+        print_tree(os.path.join(self._param.asset_dir, "setup"))
+
+    def set_setup(self, attr: str | None = None, value: any = None):
+        """
+        Change the value of an attribute of the setup in setup.setup.
+        :param attr: Name of the attribute, defaults to None
+        :type attr: str | None, optional
+        :param value: value of the attribute, defaults to None
+        :type value: any, optional
+        """
+
+        if attr is not None:
+            self.setup.update({attr: value})
+
+    def get_setup(self, attr: str | None = None):
+        """
+        Get the value of an attribute in setup.setup
+        :param attr: name of the attribute, defaults to None
+        :type attr: str | None, optional
+        """
+
+        if attr in self.setup.keys():
+            return self.setup["attr"]
+        else:
+            raise ValueError(f"attribute '{attr}' not found in setup.")
+
+    def update_setup(self, options: dict = {}):
+        """
+        Update the value of the setup with a dictionnary.
+        :param options: Dictionnary with some setup options, defaults to {}
+        """
+
+        self.setup.update(options)
+
+    def load_setup(self, filename: os.PathLike = None):
+        """
+        Load an existing setup file (.yaml)
+        :param filename: Path to the setup file, defaults to None
+        :type filename: : os.PathLike, optional
+        """
+
+        filename = check_asset_path(
+            os.path.join(self._param.asset_dir, "setup"), filename
+        )
+
+        if os.path.exists(filename):
+
+            with open(filename, "r") as file:
+
+                self.setup = yaml.safe_load(file)
+
+            self._setup_file = filename
+
+        else:
+            raise ValueError(f"{filename} does not exist.")
+
+    def write_setup(self, filename: os.PathLike = None):
+        """
+        Write the setup to a file
+        :param filename: Path to the file
+        :type filename: os.PathLike
+        """
+
+        with open(filename, "w") as file:
+
+            yaml.dump(self.setup, file)

smashbox/plot/__init__.py

@@ -0,0 +1 @@
+