ft: Created environments module, which handle the creation, staging o…

…f conda/pip/docker environments, as well as the running a source code within.

tests: added tests for EnvironmentHandler class and subclasses
build: added packaging as requirement. Harmonized requirements.txt and requirements_dev.txt

floatcsep/model.py

@@ -1,7 +1,13 @@
 import json
 import logging
+import sys
 import os
 import subprocess
+import hashlib
+import shutil
+import venv
+import configparser
+
 from abc import ABC, abstractmethod
 from datetime import datetime
 from typing import List, Callable, Union, Mapping, Sequence
@@ -124,9 +130,7 @@ def get_source(
         elif giturl:
             log.info(f"Retrieving model {self.name} from git url: " f"{giturl}")
             try:
-                from_git(
-                    giturl, self.dir if self.path.fmt else self.path("path"), **kwargs
-                )
+                from_git(giturl, self.dir if self.path.fmt else self.path("path"), **kwargs)
             except (git.NoSuchPathError, git.CommandError) as msg:
                 raise git.NoSuchPathError(f"git url was not found {msg}")
         else:
@@ -177,9 +181,7 @@ def iter_attr(val):
                 return _get_value(val)
 
         list_walk = [
-            (i, j)
-            for i, j in sorted(self.__dict__.items())
-            if not i.startswith("_") and j
+            (i, j) for i, j in sorted(self.__dict__.items()) if not i.startswith("_") and j
         ]
 
         dict_walk = {i: j for i, j in list_walk}
@@ -223,9 +225,7 @@ class TimeIndependentModel(Model):
         store_db (bool): flag to indicate whether to store the model in a database.
     """
 
-    def __init__(
-        self, name: str, model_path: str, forecast_unit=1, store_db=False, **kwargs
-    ):
+    def __init__(self, name: str, model_path: str, forecast_unit=1, store_db=False, **kwargs):
         super().__init__(name, model_path, **kwargs)
         self.forecast_unit = forecast_unit
         self.store_db = store_db
@@ -289,9 +289,7 @@ def stage(self, timewindows: Union[str, List[datetime]] = None) -> None:
 
     def get_forecast(
         self, tstring: Union[str, list] = None, region=None
-    ) -> Union[
-        GriddedForecast, CatalogForecast, List[GriddedForecast], List[CatalogForecast]
-    ]:
+    ) -> Union[GriddedForecast, CatalogForecast, List[GriddedForecast], List[CatalogForecast]]:
         """
         Wrapper that just returns a forecast when requested.
         """
@@ -333,9 +331,7 @@ def create_forecast(self, tstring: str, **kwargs) -> None:
         start_date, end_date = str2timewindow(tstring)
         self.forecast_from_file(start_date, end_date, **kwargs)
 
-    def forecast_from_file(
-        self, start_date: datetime, end_date: datetime, **kwargs
-    ) -> None:
+    def forecast_from_file(self, start_date: datetime, end_date: datetime, **kwargs) -> None:
         """
         Generates a forecast from a file, by parsing and scaling it to.
 
@@ -461,9 +457,7 @@ def stage(self, timewindows=None) -> None:
 
     def get_forecast(
         self, tstring: Union[str, list] = None, region=None
-    ) -> Union[
-        GriddedForecast, CatalogForecast, List[GriddedForecast], List[CatalogForecast]
-    ]:
+    ) -> Union[GriddedForecast, CatalogForecast, List[GriddedForecast], List[CatalogForecast]]:
         """Wrapper that just returns a forecast, hiding the access method  under the hood"""
 
         if isinstance(tstring, str):
@@ -511,9 +505,7 @@ def create_forecast(self, tstring: str, **kwargs) -> None:
         else:
             log.info(f"Forecast of {tstring} of model {self.name} already " f"exists")
 
-    def forecast_from_func(
-        self, start_date: datetime, end_date: datetime, **kwargs
-    ) -> None:
+    def forecast_from_func(self, start_date: datetime, end_date: datetime, **kwargs) -> None:
 
         self.prepare_args(start_date, end_date, **kwargs)
         log.info(

floatcsep/registry.py

@@ -118,8 +118,7 @@ def build_tree(
 
             # set forecast names
             fc_files = {
-                win: join(dirtree["forecasts"], f"{prefix}_{win}.csv")
-                for win in windows
+                win: join(dirtree["forecasts"], f"{prefix}_{win}.csv") for win in windows
             }
 
             fc_exists = {

pyproject.toml

@@ -6,4 +6,9 @@ build-backend = "setuptools.build_meta"
 addopts = "--cov=floatcsep"
 testpaths = [
     "tests",
-]
+]
+
+[tool.black]
+line-length = 96
+skip-string-normalization = false
+target-version = ["py39", "py310", "py311"]

requirements.txt

@@ -5,6 +5,8 @@ flake8
 gitpython
 h5py
 matplotlib
+packaging
+pandas
 pycsep
 pyshp
 pyyaml

requirements_dev.txt

@@ -1,5 +1,6 @@
 numpy
 cartopy
+black
 dateparser
 docker
 flake8
@@ -10,9 +11,9 @@ matplotlib
 mercantile
 mypy
 obspy
+packaging
 pandas
 pillow
-pyblack
 pycsep
 pydocstringformatter
 pyproj

setup.cfg

@@ -27,6 +27,8 @@ install_requires =
     gitpython
     h5py
     matplotlib
+    packaging
+    pandas
     pycsep
     pyshp
     pyyaml
@@ -55,6 +57,7 @@ dev =
     mercantile
     mypy
     obspy
+    packaging
     pandas
     pillow
     pycsep