fluxpark 0.1.0__tar.gz

fluxpark-0.1.0/LICENSE.txt

@@ -0,0 +1,33 @@
+FluxPark Custom License v1.0
+SPDX-License-Identifier: Custom-MoistureMatters-1.0
+Copyright © 2025 Bernard Voortman, Moisture Matters.
+
+1. License Grant  
+You are free to use, copy, modify and distribute FluxPark software, provided that you comply with all the restrictions below. This copyright notice and this list of conditions must be included in all copies or substantial portions of the software.
+
+2. Restrictions  
+  a. No SaaS/Now-Casting  
+     You may not offer FluxPark as a service (SaaS) or use it to generate recurring near-real-time outputs (for today, the past two months, or the coming month) in a repetitive manner—whether for commercial or non-commercial purposes.  
+  b. No Sub-licensing  
+     You may not sublicense the Software or impose additional restrictions on recipients without express written permission from Moisture Matters.  
+  c. Attribution  
+     In any distribution of the Software or in any publication, product, report or service that incorporates or is generated by FluxPark, you must include the following acknowledgment:  
+     ```
+     FluxPark (Moisture Matters)
+     ```
+
+3. Commercial Licensing  
+If you need to use FluxPark in a SaaS/Now-Casting context, or require a warranty or indemnification, please contact support@moisturematters.nl for a Commercial License and Support Agreement.
+
+4. Disclaimer of Warranty  
+THIS SOFTWARE IS PROVIDED “AS IS” AND “AS-AVAILABLE” WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
+
+5. Limitation of Liability  
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+6. Input Data  
+6.1. All third-party datasets distributed with FluxPark remain subject to their original licenses.  
+6.2. All proprietary datasets created by Moisture Matters and distributed as part of FluxPark are licensed under the terms of this FluxPark Custom License.
+
+7. Governing Law  
+This License shall be governed by the laws of The Netherlands, and any dispute shall be resolved in the courts of Utrecht.

fluxpark-0.1.0/PKG-INFO

@@ -0,0 +1,63 @@
+Metadata-Version: 2.4
+Name: fluxpark
+Version: 0.1.0
+Summary: Spatially-explicit hydrological model for simulating evaporation fluxes and groundwater recharge
+Author-email: Bernard Voortman <bernard.voortman@moisture-matters.nl>
+License: FluxPark Custom License v1.0
+        SPDX-License-Identifier: Custom-MoistureMatters-1.0
+        Copyright © 2025 Bernard Voortman, Moisture Matters.
+        
+        1. License Grant  
+        You are free to use, copy, modify and distribute FluxPark software, provided that you comply with all the restrictions below. This copyright notice and this list of conditions must be included in all copies or substantial portions of the software.
+        
+        2. Restrictions  
+          a. No SaaS/Now-Casting  
+             You may not offer FluxPark as a service (SaaS) or use it to generate recurring near-real-time outputs (for today, the past two months, or the coming month) in a repetitive manner—whether for commercial or non-commercial purposes.  
+          b. No Sub-licensing  
+             You may not sublicense the Software or impose additional restrictions on recipients without express written permission from Moisture Matters.  
+          c. Attribution  
+             In any distribution of the Software or in any publication, product, report or service that incorporates or is generated by FluxPark, you must include the following acknowledgment:  
+             ```
+             FluxPark (Moisture Matters)
+             ```
+        
+        3. Commercial Licensing  
+        If you need to use FluxPark in a SaaS/Now-Casting context, or require a warranty or indemnification, please contact support@moisturematters.nl for a Commercial License and Support Agreement.
+        
+        4. Disclaimer of Warranty  
+        THIS SOFTWARE IS PROVIDED “AS IS” AND “AS-AVAILABLE” WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.
+        
+        5. Limitation of Liability  
+        IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+        
+        6. Input Data  
+        6.1. All third-party datasets distributed with FluxPark remain subject to their original licenses.  
+        6.2. All proprietary datasets created by Moisture Matters and distributed as part of FluxPark are licensed under the terms of this FluxPark Custom License.
+        
+        7. Governing Law  
+        This License shall be governed by the laws of The Netherlands, and any dispute shall be resolved in the courts of Utrecht.
+        
+Project-URL: Homepage, https://github.com/Moisture-Matters/fluxpark
+Project-URL: Source, https://github.com/Moisture-Matters/fluxpark
+Project-URL: Bug Tracker, https://github.com/Moisture-Matters/fluxpark/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: Other/Proprietary License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Topic :: Scientific/Engineering :: Hydrology
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE.txt
+Requires-Dist: numpy>=1.23.4
+Requires-Dist: pandas>=1.5.1
+Requires-Dist: scipy>=1.9.2
+Requires-Dist: openpyxl>=3.0.0
+Provides-Extra: test
+Requires-Dist: pytest>=7.0; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: flake8; extra == "test"
+Provides-Extra: docs
+Requires-Dist: sphinx; extra == "docs"
+Requires-Dist: sphinx-rtd-theme; extra == "docs"
+Dynamic: license-file

fluxpark-0.1.0/pyproject.toml

@@ -0,0 +1,49 @@
+[project]
+name             = "fluxpark"
+version          = "0.1.0"
+description      = "Spatially-explicit hydrological model for simulating evaporation fluxes and groundwater recharge"
+readme           = "README.md"
+requires-python  = ">=3.9"
+license          = { file = "LICENSE.txt" }
+authors          = [
+  { name="Bernard Voortman", email="bernard.voortman@moisture-matters.nl" }
+]
+dependencies     = [
+  "numpy>=1.23.4",
+  "pandas>=1.5.1",
+  "scipy>=1.9.2",
+  "openpyxl>=3.0.0",
+]
+classifiers      = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Science/Research",
+  "License :: Other/Proprietary License",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.9",
+  "Topic :: Scientific/Engineering :: Hydrology",
+]
+
+[project.urls]
+Homepage      = "https://github.com/Moisture-Matters/fluxpark"
+Source        = "https://github.com/Moisture-Matters/fluxpark"
+"Bug Tracker" = "https://github.com/Moisture-Matters/fluxpark/issues"
+
+[project.optional-dependencies]
+test = ["pytest>=7.0", "pytest-cov", "flake8"]
+docs = ["sphinx", "sphinx-rtd-theme"]
+
+[build-system]
+requires      = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.flake8]
+max-line-length = 88
+ignore = ["E203", "W503"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]        # only files with test_ prefix
+python_functions = ["test_*"]       # only functions with test_ prefix

fluxpark-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

fluxpark-0.1.0/src/fluxpark/__init__.py

@@ -0,0 +1,43 @@
+import importlib
+import pkgutil
+from importlib.metadata import version, PackageNotFoundError
+
+try:
+    __version__ = version(__name__)
+except PackageNotFoundError:
+    __version__ = "0.0.0"  # for development
+
+
+# import all modules dynamically
+from . import config
+from . import setup
+from . import io
+from . import postprocessing
+from . import prepgrids
+from . import submodels
+from . import utils
+from . import workflow
+from .workflow.runner import FluxParkRunner
+
+__all__ = [
+    "config",
+    "setup",
+    "io",
+    "postprocessing",
+    "prepgrids",
+    "utils",
+    "workflow",
+    "FluxParkRunner",
+]
+
+for loader, module_name, is_pkg in pkgutil.iter_modules(submodels.__path__):
+    if module_name == "__init__":
+        continue  # skip __init__.py
+
+    full_module_name = f"{submodels.__name__}.{module_name}"
+    module = importlib.import_module(full_module_name)
+
+    for attr in dir(module):
+        if not attr.startswith("_"):
+            globals()[attr] = getattr(module, attr)
+            __all__.append(attr)

fluxpark-0.1.0/src/fluxpark/config/__init__.py

@@ -0,0 +1,3 @@
+from .fluxpark_config import FluxParkConfig
+
+__all__ = ["FluxParkConfig"]

fluxpark-0.1.0/src/fluxpark/config/fluxpark_config.py

@@ -0,0 +1,117 @@
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Optional, Union
+
+
+@dataclass
+class FluxParkConfig:
+    """
+    Configuration settings for the FluxPark core simulation model.
+
+    This configuration object contains all general and spatial parameters
+    required to run the core model. It does not include any Nexus-specific logic.
+
+    Parameters
+    ----------
+    date_start : str
+        Start date of the simulation period (format: 'DD-MM-YYYY').
+    date_end : str
+        End date of the simulation period (format: 'DD-MM-YYYY').
+    mask : Optional[str]
+        Filename of the cutline raster mask used to clip input layers.
+    calc_epsg_code : int
+        EPSG code for the coordinate reference system used in calculations.
+    x_min : float
+        Minimum x-coordinate of the simulation extent.
+    x_max : float
+        Maximum x-coordinate of the simulation extent.
+    y_min : float
+        Minimum y-coordinate of the simulation extent.
+    y_max : float
+        Maximum y-coordinate of the simulation extent.
+    cellsize : float
+        Grid cell size (in map units) used for resampling input rasters.
+    evap_param_table : str
+        Filename of the Excel file containing evaporation parameters.
+    output_files : list[str] or str, default = "flagship"
+        List of output parameters to write to file or a string describing differnt
+        combinations of output (all, flagship).
+
+    indir : Union[str, Path], default='./input_data'
+        Root directory containing all input files.
+    indir_rasters : Optional[Union[str, Path]], default=None
+        Directory containing raster input files. If None, defaults to `indir/rasters`.
+    indir_masks : Optional[Union[str, Path]], default=None
+        Directory containing mask rasters. If None, defaults to `indir/masks`.
+    landuse_rastername : str, default="{year}_luse_ids.tif"
+        Filename pattern for the yearly land use raster.
+    root_soilm_scp_rastername : str, default="{year}_root_soilm_fc_scp_mm.tif"
+        Filename pattern for the soil moisture field capacity raster (saturated).
+    root_soilm_pwp_rastername : str, default="{year}_root_soilm_fc_pwp_mm.tif"
+        Filename pattern for the soil moisture wilting point raster.
+    impervdens_rastername : str, default="2018_impervdens.tif"
+        Filename of the imperviousness raster.
+    soil_cov_decid_rastername : str, default="forest_decid_soilcov_100m_3035.tif"
+        Filename of the deciduous forest cover raster.
+    soil_cov_conif_rastername : str, default="forest_conif_soilcov_100m_3035.tif"
+        Filename of the coniferous forest cover raster.
+    output_mapping : str, default="fluxpark_output_mapping.csv"
+        Filename of the mapping table from variables to parameters.
+    store_states : bool, default=False
+        If true, calculation parameters are added to the output list.
+    reset_cum_day : int, default=1
+        Day of the month when cumulative variables are reset.
+    reset_cum_month : int, default=1
+        Month when cumulative variables are reset.
+    mod_vegcover : bool, default=False
+        Whether to include dynamic vegetation cover in simulations.
+    only_yearly_output : bool, default=False
+        If True, only writes output at the end of the year (31 Dec).
+    parallel : bool, default=True
+        Whether to parallelize output writing.
+    max_workers : Optional[int], default=None
+        Maximum number of parallel workers (threads) to use.
+    outdir : Union[str, Path], default="./output_data"
+        Output directory where model results are stored.
+    intermediate_dir : Optional[Union[str, Path]], default=None
+        Optional intermediate directory for temporary files.
+    """
+
+    # Positional (non-default) arguments
+    date_start: str
+    date_end: str
+    mask: Optional[str]
+    calc_epsg_code: int
+    x_min: float
+    x_max: float
+    y_min: float
+    y_max: float
+    cellsize: float
+    evap_param_table: str
+
+    # Defaulted arguments
+    output_files: Union[str, list[str], list[int]] = "flagship"
+    indir: Union[str, Path] = "./input_data"
+    indir_rasters: Optional[Union[str, Path]] = None
+    indir_masks: Optional[Union[str, Path]] = None
+
+    landuse_rastername: str = "{year}_luse_ids.tif"
+    root_soilm_scp_rastername: str = "{year}_root_soilm_fc_scp_mm.tif"
+    root_soilm_pwp_rastername: str = "{year}_root_soilm_fc_pwp_mm.tif"
+    impervdens_rastername: str = "2018_impervdens.tif"
+    soil_cov_decid_rastername: str = "forest_decid_soilcov_100m_3035.tif"
+    soil_cov_conif_rastername: str = "forest_conif_soilcov_100m_3035.tif"
+    output_mapping: str = "fluxpark_output_mapping.csv"
+    store_states: bool = False
+
+    reset_cum_day: int = 1
+    reset_cum_month: int = 1
+
+    mod_vegcover: bool = False
+
+    only_yearly_output: bool = False
+    parallel: bool = True
+    max_workers: Optional[int] = None
+
+    outdir: Union[str, Path] = "./output_data"
+    intermediate_dir: Optional[Union[str, Path]] = None

fluxpark-0.1.0/src/fluxpark/io/__init__.py

@@ -0,0 +1,4 @@
+from .raster_tools import GeoTiffReader, NetCDFReader, write_geotiff
+from .vector_tools import write_point_layer
+
+__all__ = ["GeoTiffReader", "NetCDFReader", "write_geotiff", "write_point_layer"]