siim-lem 0.9.4__tar.gz

siim_lem-0.9.4/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Eric Deal
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. 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.

siim_lem-0.9.4/MANIFEST.in

@@ -0,0 +1,23 @@
+# Keep direct development-checkout source distributions on the same public
+# boundary as the release exporter. Include public documentation, package
+# tests, and their reference data even before a newly added file is committed.
+recursive-include docs *.bib *.md *.pdf *.png *.py *.txt
+recursive-include siim/tests *.npz *.py
+
+prune _memory
+prune docs/dev
+prune docs/_build
+prune escarpment_code
+prune notebooks
+prune paper_drafts
+prune siim/tests/data/reference_local
+prune tools
+prune .github
+
+exclude CLAUDE.md
+exclude for_thea.zip
+
+global-exclude .DS_Store
+global-exclude *.py[cod]
+global-exclude *.nb[ci]
+global-exclude __pycache__

siim_lem-0.9.4/PKG-INFO

@@ -0,0 +1,117 @@
+Metadata-Version: 2.4
+Name: siim-lem
+Version: 0.9.4
+Summary: Sliding Ice Incision Model (siim): coupled glacial-fluvial landscape evolution.
+Author: Eric Deal
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/ericdealgeomorph/siim
+Project-URL: Documentation, https://github.com/ericdealgeomorph/siim/tree/main/docs
+Project-URL: Repository, https://github.com/ericdealgeomorph/siim
+Project-URL: Issues, https://github.com/ericdealgeomorph/siim/issues
+Project-URL: Changelog, https://github.com/ericdealgeomorph/siim/blob/main/CHANGELOG.md
+Keywords: geomorphology,glacier,landscape evolution,numerical modeling
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Physics
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy
+Requires-Dist: scipy
+Requires-Dist: numba
+Requires-Dist: matplotlib
+Requires-Dist: tqdm
+Requires-Dist: xarray
+Requires-Dist: pandas
+Provides-Extra: fastscape
+Requires-Dist: fastscape; extra == "fastscape"
+Requires-Dist: xarray-simlab; extra == "fastscape"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: mpmath; extra == "test"
+Provides-Extra: docs
+Requires-Dist: sphinx>=8; extra == "docs"
+Requires-Dist: furo; extra == "docs"
+Requires-Dist: myst-nb; extra == "docs"
+Requires-Dist: sphinxcontrib-bibtex; extra == "docs"
+Requires-Dist: ipykernel; extra == "docs"
+Provides-Extra: release
+Requires-Dist: build; extra == "release"
+Requires-Dist: twine; extra == "release"
+Provides-Extra: dev-parity
+Requires-Dist: fastscapelib; extra == "dev-parity"
+Dynamic: license-file
+
+# siim — Sliding Ice Incision Model
+
+Coupled glacial–fluvial landscape evolution. `siim` models bedrock incision by
+sliding ice and rivers together, resolving how glaciers and channels jointly
+shape mountain topography over geologic time. It ships three coordinated front
+ends over one physical core:
+
+- **`siim.siim1d`** — fast 1D longitudinal-profile model
+- **`siim.siim2d`** — full 2D landscape-evolution model (in-house driver, D8/D-inf
+  routing, FFT flexure, ADI hillslope diffusion)
+- **`siim.analytical`** — closed-form steady-state profiles and regime diagrams
+  from the underlying theory
+
+Python with NumPy/SciPy/Numba — no Fortran and no framework lock-in for the
+standalone models.
+
+## Install
+
+```bash
+pip install siim-lem
+```
+
+`siim` runs the full 1D and 2D models standalone on NumPy 2. An optional adapter
+lets you drive the 2D model through [fastscape](https://fastscape.org)/xsimlab
+instead of the built-in driver; that stack is conda-only:
+
+```bash
+conda env create -f environment.yml   # optional fastscape adapter
+```
+
+Requires Python ≥ 3.12.
+
+## Quickstart
+
+```python
+from siim import siim2d
+
+params = {
+    'U': 1e-3,                          # rock uplift rate (m/yr)
+    'zELA': 1500, 'P': 2, 'beta': 1e-2, # climate: ELA + mass balance
+    'ce': 2e-5, 'Ko': 1e-6,             # glacial + fluvial erodibility
+    'Lx': 100e3, 'Ly': 50e3,            # domain size (m)
+    'nx': 201, 'ny': 101,               # grid
+    'T': 5e6, 'nt': 501, 'nt_out': 51,  # 5 Myr run
+    'seed': 0,                           # reproducible initial relief noise
+    'mode': 'C',                        # bed-memory + sub-grid glacier carving
+}
+
+model = siim2d.siim(params)
+model.run()
+model.plot.landscape(i=-1)             # final topography
+```
+
+The 1D model (`from siim.siim1d import siim`) and the analytical solutions
+(`from siim.analytical import GeneralProfile`) follow the same shape. See the
+[documentation](https://github.com/ericdealgeomorph/siim/tree/main/docs) for the full parameter reference,
+guides, and the theory background.
+
+## Citing
+
+If you use `siim`, please cite it via [`CITATION.cff`](CITATION.cff). A methods
+paper is in preparation.
+
+## License
+
+[MIT](LICENSE) © Eric Deal

siim_lem-0.9.4/README.md

@@ -0,0 +1,66 @@
+# siim — Sliding Ice Incision Model
+
+Coupled glacial–fluvial landscape evolution. `siim` models bedrock incision by
+sliding ice and rivers together, resolving how glaciers and channels jointly
+shape mountain topography over geologic time. It ships three coordinated front
+ends over one physical core:
+
+- **`siim.siim1d`** — fast 1D longitudinal-profile model
+- **`siim.siim2d`** — full 2D landscape-evolution model (in-house driver, D8/D-inf
+  routing, FFT flexure, ADI hillslope diffusion)
+- **`siim.analytical`** — closed-form steady-state profiles and regime diagrams
+  from the underlying theory
+
+Python with NumPy/SciPy/Numba — no Fortran and no framework lock-in for the
+standalone models.
+
+## Install
+
+```bash
+pip install siim-lem
+```
+
+`siim` runs the full 1D and 2D models standalone on NumPy 2. An optional adapter
+lets you drive the 2D model through [fastscape](https://fastscape.org)/xsimlab
+instead of the built-in driver; that stack is conda-only:
+
+```bash
+conda env create -f environment.yml   # optional fastscape adapter
+```
+
+Requires Python ≥ 3.12.
+
+## Quickstart
+
+```python
+from siim import siim2d
+
+params = {
+    'U': 1e-3,                          # rock uplift rate (m/yr)
+    'zELA': 1500, 'P': 2, 'beta': 1e-2, # climate: ELA + mass balance
+    'ce': 2e-5, 'Ko': 1e-6,             # glacial + fluvial erodibility
+    'Lx': 100e3, 'Ly': 50e3,            # domain size (m)
+    'nx': 201, 'ny': 101,               # grid
+    'T': 5e6, 'nt': 501, 'nt_out': 51,  # 5 Myr run
+    'seed': 0,                           # reproducible initial relief noise
+    'mode': 'C',                        # bed-memory + sub-grid glacier carving
+}
+
+model = siim2d.siim(params)
+model.run()
+model.plot.landscape(i=-1)             # final topography
+```
+
+The 1D model (`from siim.siim1d import siim`) and the analytical solutions
+(`from siim.analytical import GeneralProfile`) follow the same shape. See the
+[documentation](https://github.com/ericdealgeomorph/siim/tree/main/docs) for the full parameter reference,
+guides, and the theory background.
+
+## Citing
+
+If you use `siim`, please cite it via [`CITATION.cff`](CITATION.cff). A methods
+paper is in preparation.
+
+## License
+
+[MIT](LICENSE) © Eric Deal

siim_lem-0.9.4/docs/api/analytical.md

@@ -0,0 +1,37 @@
+# Analytical steady state
+
+```{eval-rst}
+.. automodule:: siim.analytical
+```
+
+## Math kernel — `siim.analytical.core`
+
+```{eval-rst}
+.. automodule:: siim.analytical.core
+   :members:
+   :show-inheritance:
+```
+
+## Profile classes — `siim.analytical.profiles`
+
+```{eval-rst}
+.. automodule:: siim.analytical.profiles
+   :members:
+   :show-inheritance:
+```
+
+## Physical front end — `siim.analytical.steady_state`
+
+```{eval-rst}
+.. automodule:: siim.analytical.steady_state
+   :members:
+   :show-inheritance:
+```
+
+## Regime map — `siim.analytical.regime`
+
+```{eval-rst}
+.. automodule:: siim.analytical.regime
+   :members:
+   :show-inheritance:
+```

siim_lem-0.9.4/docs/api/core.md

@@ -0,0 +1,123 @@
+# Numerical core — `siim._core`
+
+The fastscape-free numerical kernels shared by the 1D profile model and the 2D
+landscape model. Most use NumPy/Numba; spectral flexure uses SciPy. They need no
+fastscape, xsimlab, or Matplotlib, so the numerics remain testable without the
+optional adapter or plotting layer. The 1D and 2D models build one
+`GlacialParams` record and an integer `law_code` and call the step skeletons
+directly.
+
+## Per-run parameter record — `siim._core.params`
+
+```{eval-rst}
+.. automodule:: siim._core.params
+   :members:
+   :show-inheritance:
+```
+
+## Step skeletons (law_code switch) — `siim._core.skeleton`
+
+```{eval-rst}
+.. automodule:: siim._core.skeleton
+   :members:
+   :private-members:
+```
+
+## Scalar Newton solvers & ice-thickness closures — `siim._core.solvers`
+
+```{eval-rst}
+.. automodule:: siim._core.solvers
+   :members:
+   :private-members:
+```
+
+## 2D erosion loops — `siim._core.eroders`
+
+```{eval-rst}
+.. automodule:: siim._core.eroders
+   :members:
+   :private-members:
+```
+
+## Sub-grid glacier-width carving — `siim._core.carve`
+
+```{eval-rst}
+.. automodule:: siim._core.carve
+   :members:
+   :private-members:
+```
+
+## Explicit H diffusion — `siim._core.diffusion`
+
+```{eval-rst}
+.. automodule:: siim._core.diffusion
+   :members:
+   :private-members:
+```
+
+## Hillslope diffusion (ADI) — `siim._core.hillslope`
+
+In-house alternating-direction-implicit hillslope diffuser (topography), the
+standalone replacement for fastscapelib-fortran's `fs.diffusion`. Distinct from
+`siim._core.diffusion` (the ice-thickness FD diffuser above).
+
+```{eval-rst}
+.. automodule:: siim._core.hillslope
+   :members:
+   :private-members:
+```
+
+## Spectral flexure — `siim._core.flexure`
+
+In-house `scipy.fft` thin-plate flexure solve on the native grid, the standalone
+replacement for fastscapelib-fortran's `fs.flexure`.
+
+```{eval-rst}
+.. automodule:: siim._core.flexure
+   :members:
+   :private-members:
+```
+
+## Flow routing & accumulation primitives — `siim._core.routing`
+
+```{eval-rst}
+.. automodule:: siim._core.routing
+   :members:
+   :private-members:
+```
+
+## Composition-chain step functions — `siim._core.step`
+
+Framework-free extractions of the 2D model's per-step composition chain (one
+`self`-free function per `siim.fastscape` process `run_step` body). The xsimlab
+adapter shells and the standalone driver call the same functions.
+
+```{eval-rst}
+.. automodule:: siim._core.step
+   :members:
+   :private-members:
+```
+
+## In-house time loop — `siim._core.driver`
+
+The standalone driver: siim's own merged step loop + two-cadence snapshot,
+calling the same step functions the adapter shells call. Selected via
+`run(driver='inhouse')` (default `constants.DRIVER_DEFAULT`).
+
+```{eval-rst}
+.. automodule:: siim._core.driver
+   :members:
+   :private-members:
+```
+
+## Output packing — `siim._core.outputs`
+
+Packs the driver's step buffers into the exact `ds_out` contract
+(variable names, `(time, y, x)` dims, dtypes, coords) that
+`siim.siim2d.siim._unpack_outputs` reads.
+
+```{eval-rst}
+.. automodule:: siim._core.outputs
+   :members:
+   :private-members:
+```

siim_lem-0.9.4/docs/api/fastscape.md

@@ -0,0 +1,35 @@
+# fastscape integration — `siim.fastscape`
+
+The public, composable surface for using siim's glacial-erosion physics inside
+your own fastscape/xsimlab model: the assembly helpers (`glacial_processes`,
+`glacial_model`) and the `@xs.process` classes they wire in. This is the
+**optional adapter** (`pip install siim[fastscape]`; conda for the Fortran
+backend) — the standalone `siim.siim2d` model runs its own in-house driver and
+does not require it, though `siim2d(...).run(driver='xsimlab')` will drive the
+model through this adapter when the stack is present.
+
+## Public surface — `siim.fastscape`
+
+```{eval-rst}
+.. automodule:: siim.fastscape
+
+.. autofunction:: siim.fastscape.glacial_processes
+
+.. autofunction:: siim.fastscape.glacial_model
+```
+
+## Glacial processes — `siim.fastscape.processes`
+
+```{eval-rst}
+.. automodule:: siim.fastscape.processes
+   :members:
+   :show-inheritance:
+```
+
+## Forcing processes — `siim.fastscape.forcing`
+
+```{eval-rst}
+.. automodule:: siim.fastscape.forcing
+   :members:
+   :show-inheritance:
+```

siim_lem-0.9.4/docs/api/index.md

@@ -0,0 +1,44 @@
+# API reference
+
+```{eval-rst}
+.. autosummary::
+
+   siim
+   siim.analytical
+   siim.analytical.core
+   siim.analytical.profiles
+   siim.analytical.regime
+   siim.analytical.steady_state
+   siim.constants
+   siim.forcing
+   siim._core.params
+   siim._core.skeleton
+   siim._core.solvers
+   siim._core.eroders
+   siim._core.carve
+   siim._core.diffusion
+   siim._core.routing
+   siim.siim1d
+   siim.siim2d
+   siim.fastscape
+   siim.fastscape.processes
+   siim.fastscape.forcing
+   siim.plotting
+   siim.plotting.maps
+   siim.plotting.profiles
+   siim.plotting.landscape
+   siim.plotting.basins
+   siim.plotting.diagnostics
+   siim.escarpment
+```
+
+```{toctree}
+:maxdepth: 1
+
+analytical
+model1d
+model2d
+fastscape
+core
+support
+```

siim_lem-0.9.4/docs/api/model1d.md

@@ -0,0 +1,15 @@
+# 1D profile model
+
+The constructor accepts a parameter dictionary; see
+{doc}`../guides/parameter_reference` for every key and resolved default.
+
+```{eval-rst}
+.. automodule:: siim.siim1d
+
+.. autoclass:: siim.siim1d.siim
+   :members: run, rms_vs_analytical
+   :show-inheritance:
+
+.. autoclass:: siim.siim1d.siim_plotter
+   :members:
+```

siim_lem-0.9.4/docs/api/model2d.md

@@ -0,0 +1,77 @@
+# 2D landscape model
+
+The constructor accepts a parameter dictionary; see
+{doc}`../guides/parameter_reference` for every key and mode-dependent default.
+
+## Wrapper / dispatch — `siim.siim2d`
+
+```{eval-rst}
+.. automodule:: siim.siim2d
+
+.. autoclass:: siim.siim2d.siim
+   :members: run, save, load, extract_channel, strahler_order
+   :show-inheritance:
+
+.. autofunction:: siim.siim2d.load
+```
+
+The standalone driver uses the fastscape-free numerical core for routing,
+ice-thickness closure, erosion, sub-grid carving, diffusion, and flexure; see
+{doc}`core`. Optional xsimlab process shells around the same step functions are
+documented in {doc}`fastscape`.
+
+## Plotting — `siim.plotting`
+
+```{eval-rst}
+.. automodule:: siim.plotting
+   :members:
+   :show-inheritance:
+```
+
+### Raw 2D fields — `siim.plotting.maps`
+
+```{eval-rst}
+.. automodule:: siim.plotting.maps
+   :members:
+   :show-inheritance:
+```
+
+### Channel profiles & cross-sections — `siim.plotting.profiles`
+
+```{eval-rst}
+.. automodule:: siim.plotting.profiles
+   :members:
+   :show-inheritance:
+```
+
+### Deluxe landscape — `siim.plotting.landscape`
+
+```{eval-rst}
+.. automodule:: siim.plotting.landscape
+   :members:
+   :show-inheritance:
+```
+
+### Basin & channel diagnostics — `siim.plotting.basins`
+
+```{eval-rst}
+.. automodule:: siim.plotting.basins
+   :members:
+   :show-inheritance:
+```
+
+### Steady-state diagnostics — `siim.plotting.diagnostics`
+
+```{eval-rst}
+.. automodule:: siim.plotting.diagnostics
+   :members:
+   :show-inheritance:
+```
+
+## Escarpment variant — `siim.escarpment`
+
+```{eval-rst}
+.. automodule:: siim.escarpment
+   :members:
+   :show-inheritance:
+```

siim_lem-0.9.4/docs/api/support.md

@@ -0,0 +1,21 @@
+# Constants and support modules
+
+## Package entry — `siim`
+
+```{eval-rst}
+.. automodule:: siim
+```
+
+## Constants — `siim.constants`
+
+```{eval-rst}
+.. automodule:: siim.constants
+   :members:
+```
+
+## Time-varying forcing builders — `siim.forcing`
+
+```{eval-rst}
+.. automodule:: siim.forcing
+   :members:
+```

siim_lem-0.9.4/docs/conf.py

@@ -0,0 +1,66 @@
+# Sphinx configuration for the siim documentation.
+#
+# Local build (from an environment with docs/requirements.txt installed):
+#   python -m sphinx -W -b html docs docs/_build/html
+# The standard 1D/2D stack is installed on Read the Docs. Optional adapter or
+# presentation dependencies that are absent are mocked so autodoc can still
+# import their public modules.
+import importlib.util
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath('..'))  # repo root (editable installs too)
+
+project = 'siim'
+author = 'Eric Deal'
+copyright = '2026, Eric Deal'
+
+extensions = [
+    'myst_nb',                    # markdown + (optional) notebook pages
+    'sphinx.ext.autodoc',
+    'sphinx.ext.autosummary',
+    'sphinx.ext.napoleon',
+    'sphinx.ext.mathjax',
+    'sphinx.ext.viewcode',
+    'sphinx.ext.intersphinx',
+    'sphinxcontrib.bibtex',
+]
+
+# Mock only optional adapter/presentation dependencies that are actually
+# missing. NumPy/SciPy are hard requirements and are never mocked.
+autodoc_mock_imports = [
+    m for m in ('numba', 'xsimlab', 'fastscape', 'matplotlib', 'mpl_toolkits',
+                'pandas', 'tqdm')
+    if importlib.util.find_spec(m) is None
+]
+
+autosummary_generate = False      # module pages are hand-written (docs/api/)
+autodoc_member_order = 'bysource'
+
+napoleon_google_docstring = False
+napoleon_numpy_docstring = True
+
+myst_enable_extensions = ['dollarmath', 'amsmath']
+# Execute notebook pages (markdown notebooks carrying a kernelspec — e.g. the
+# 1D getting-started walkthrough) at build time so the examples stay tested.
+# The quick 1D notebook page executes during the build. The larger 2D example
+# remains plain Markdown so documentation builds do not run a landscape model.
+nb_execution_mode = 'auto'
+nb_execution_raise_on_error = True   # a broken example fails the build
+nb_execution_timeout = 300           # allow for numba JIT on the first run
+nb_output_stderr = 'remove'          # keep tqdm/progress bars out of the render
+
+bibtex_bibfiles = ['references.bib']
+
+intersphinx_mapping = {
+    'python': ('https://docs.python.org/3', None),
+    'numpy': ('https://numpy.org/doc/stable/', None),
+}
+
+templates_path = []
+# Internal development notes are not part of the rendered public documentation;
+# exclude that tree and common generated files.
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store', '**/__pycache__', 'dev/**']
+
+html_theme = 'furo'
+html_title = 'siim'