symfluence 0.5.0__tar.gz

symfluence-0.5.0/.gitignore

@@ -0,0 +1,94 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+examples/*/.ipynb_checkpoints/
+.confluence_env
+mpi_*
+
+
+# Virtual Environment
+venv/
+ENV/
+env/
+.env/
+.venv/
+
+# Ignore everything in 0_config_files
+0_config_files/*
+
+
+# But keep config_template.yaml
+!0_config_files/config_template.yaml
+!0_config_files/README.md
+
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# macOS system files
+.DS_Store
+.AppleDouble
+.LSOverride
+Icon
+._*
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Jupyter Notebook
+.ipynb_checkpoints
+*/*/.ipynb_checkpoints/*
+
+# Model outputs and temporary files
+*.log
+*.err
+*.out
+*.pkl
+temp/
+logs/
+
+# Distribution
+*.manifest
+*.spec
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/*.nc
+*.err
+*.err

symfluence-0.5.0/0_base_settings/README.md

@@ -0,0 +1,58 @@
+# Base Settings
+
+This directory contains the default configuration templates and parameter files for all supported hydrological models in SYMFLUENCE.  
+These serve as **clean, validated starting points** for new projects and ensure reproducible, consistent model setup across workflows.
+
+---
+
+## 1. Structure
+
+Each subdirectory includes model-specific base templates:
+
+- **SUMMA/** — Parameter files, decision file, and file manager templates for SUMMA model setup  
+  → [CH-Earth SUMMA Repository](https://github.com/CH-Earth/SUMMA)
+
+- **FUSE/** — Configuration templates and parameter definitions for FUSE model applications  
+  → [CH-Earth FUSE Repository](https://github.com/CH-Earth/FUSE)
+
+- **mizuRoute/** — Network topology, routing parameter files, and control templates for mizuRoute  
+  → [CH-Earth mizuRoute Repository](https://github.com/CH-Earth/mizuRoute)
+
+- **NOAH/** — Parameter files for the NOAH Land Surface Model used in **NextGen-style** workflows.
+  → [CH-Earth NOAH Repository](https://github.com/CH-Earth/noah-lsm)
+
+---
+
+## 2. Usage
+
+Base settings are automatically copied into each project during model preprocessing:
+```bash
+./symfluence --preprocess_models --config my_project.yaml
+```
+
+Copied files can then be safely modified without affecting the base templates.  
+This ensures:
+- Clean defaults for every new project  
+- Reproducibility across model setups  
+- Isolation between experiments
+
+---
+
+## 3. Customization Guidelines
+
+- **Avoid editing files here directly.**  
+  Changes will affect all future projects.  
+  Instead, modify the copies within your project directory.
+
+- Use version control to track any changes for transparency.
+- When adding support for new models, follow the directory structure and naming conventions used here.
+
+---
+
+## 4. References
+
+For full model documentation and parameter details:
+- [SUMMA – Structure for Unifying Multiple Modeling Alternatives](https://github.com/CH-Earth/SUMMA)  
+- [FUSE – Framework for Understanding Structural Errors](https://github.com/CH-Earth/FUSE)  
+- [mizuRoute – River Network Routing Tool](https://github.com/CH-Earth/mizuRoute)  
+- [NOAH – Land Surface Model](https://github.com/CH-Earth/noah-lsm)

symfluence-0.5.0/0_config_files/README.md

@@ -0,0 +1,63 @@
+# Configuration Files
+
+This directory contains the configuration templates that control all aspects of CONFLUENCE workflows.  
+Configurations define experiment setup, model selection, data paths, and analysis parameters across the workflow—from conceptualization to evaluation.
+
+---
+
+## 1. Configuration Structure
+
+All configurations are written in **YAML** and follow the logical sequence of the workflow.  
+Each section feeds into the next to ensure consistency and reproducibility.
+
+### Sections
+- **Global Settings** — Define directories, domain names, and experiment IDs.  
+- **Geospatial** — Configure watershed delineation, coordinate systems, and spatial discretization.  
+- **Model-Agnostic** — Specify preprocessing, forcing data, and format standardization.  
+- **Model-Specific** — Provide setup parameters for SUMMA, FUSE, NEXTGEN, GR, LSTM.  
+- **Evaluation** — Define performance metrics, benchmarking methods, and visualization settings.  
+- **Optimization** — Configure calibration targets, objective functions, and algorithms.
+
+---
+
+## 2. Working with Configurations
+
+### Creating a New Configuration
+Start from the provided template:
+```bash
+cp config_template.yaml config_active.yaml
+```
+Edit from top to bottom:
+1. Define global paths and domain details.  
+2. Set model and calibration parameters.  
+3. Verify settings using built-in validation tools.
+
+### Hierarchy and Dependencies
+Each section uses values defined in earlier ones.  
+This ensures parameter inheritance, consistent file paths, and workflow synchronization.
+
+### Path Management
+Default paths align with CONFLUENCE’s directory structure, but you can override them to match existing data or cluster environments.
+
+### Multi-Model Workflows
+You can run several models within a single configuration for intercomparison or ensemble experiments.  
+Each model block operates independently while sharing the global setup.
+
+---
+
+## 3. Best Practices
+
+### Configuration Management
+- Maintain one configuration per experiment or domain.  
+- Use descriptive experiment identifiers.  
+- Avoid editing active configurations—create copies for new runs.
+
+### Documentation
+Comment on any non-default values directly within YAML files.  
+This supports reproducibility and provides clarity for future analysis.
+
+---
+
+## 4. Troubleshooting
+- Review error messages carefully; they include direct hints for correction.  
+- The configuration template provides defaults and recommended values.