You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
TopoPyScale is a Python package for topography-based downscaling of climate data to hillslope scale. It processes climate reanalysis data (ERA5, etc.) and digital elevation models (DEM) to produce outputs for models like Cryogrid and FSM. The codebase is organized as a PyPI library, with main logic in the `TopoPyScale/` directory and documentation in `doc/`.
5
+
6
+
## Key Components
7
+
-**Core Library:** All main modules are in `TopoPyScale/`. Each file typically handles a specific aspect (e.g., `fetch_dem.py` for DEM fetching, `topo_scale.py` for downscaling logic).
8
+
-**Documentation:** Markdown docs are in `doc/docs/`. API docs are auto-generated using `lazydocs`.
9
+
-**Configuration:** Project uses `pyproject.toml` and `MANIFEST.in` for packaging. Documentation build is managed by `mkdocs.yml`.
10
+
11
+
## Developer Workflows
12
+
-**Testing:** GitHub Actions run tests via `test_topopyscale.yml`. Local test commands are not specified; add/maintain tests in the main package directory.
13
+
-**Documentation:**
14
+
- Edit docs in `doc/docs/`.
15
+
- Build locally: `mkdocs serve` (see `doc/README.md`).
16
+
- API docs: Run `lazydocs` as described in `doc/README.md`.
17
+
-**Releases:** Create a new branch for features/bugfixes, merge to `main`, then follow release video guide (see `README.md`).
18
+
19
+
## Project-Specific Patterns
20
+
-**Data Flow:**
21
+
- Inputs: Climate data (ERA5, CORDEX), DEM (local or fetched).
0 commit comments