Develop

.dockerignore

@@ -0,0 +1,50 @@
+# .dockerignore — keep Docker build context small.
+# Applies when building from the repo root (as docker-compose.yml does:
+#   context: ..  → this file).
+#
+# Only source code + CMakeLists.txt are needed to build FLUXOS inside the
+# image. Simulation outputs, local build dirs, git history, web assets, and
+# auxiliary Python/R scripts are all excluded.
+
+# Version control
+.git
+.gitignore
+.gitmodules
+.github
+
+# Local IDE / tooling state
+.claude
+.vscode
+.idea
+.DS_Store
+
+# Local CMake build outputs (users often have several of these)
+build
+build_*
+cmake-build-*
+
+# Simulation outputs (can be multi-GB)
+Results
+Results_*
+Working_example
+
+# Documentation / web / wiki assets — not needed for the FLUXOS build
+in_a_nutshell
+wikipage
+supporting_scripts
+
+# Stray images / figures at the repo root
+*.png
+*.jpg
+*.pdf
+
+# Runtime input data — mounted at runtime via docker-compose volumes,
+# so not needed inside the image itself.
+bin
+
+# Python caches
+__pycache__
+*.pyc
+
+# Container files themselves are not needed inside the image we're building
+containers

.gitignore

@@ -1,4 +1,8 @@
 Results/
+Results_steady/
+Results_river_steady/
+Results_river_30h/
+Results_docker_test/
 CMakefiles/
 .gitignore
 .vscode
@@ -7,4 +11,59 @@ Makefile
 Tests/
 cmake_install.cmake
 logFLUXOS.out
-fluxos_cpp
+fluxos_cpp
+build/
+build_soil/
+.DS_Store
+*.tif
+# Exception: the Rosa Creek GeoTIFF is the default-template case study and
+# must ship with the repo so `python model_config_template.py` works
+# out-of-the-box on a fresh clone.
+!Working_example/Rosa_2m.tif
+bin/fluxos_run.log
+fluxos_web/data/
+fluxos_kml_regular/
+horton_infiltration_results.png
+
+# --- Working_example/ ------------------------------------------------------
+# Only the two inputs needed by the default Rosa Creek template (the
+# GeoTIFF and the synthetic meteo forcing) are committed. Everything else
+# in this folder is either a per-run output or test-case leftover that is
+# regenerated from the templates — don't track them.
+Working_example/*.asc
+Working_example/*.msh
+Working_example/modset*.json
+Working_example/*.log
+# Ad-hoc project forcings that aren't referenced by the default template.
+Working_example/Flow_*.fluxos
+# Keep these files regardless of the patterns above — they are the inputs
+# for the ready-to-run example shown on compile-deck slide 7
+# (`./bin/fluxos Working_example/modset_river_30h.json` right after compile,
+# no Python preprocessing needed):
+!Working_example/Qmelt_synthetic.fluxos
+!Working_example/Rosa_2m.asc
+!Working_example/Flow_river_30h.fluxos
+!Working_example/modset_river_30h.json
+# Generated WebGL / KML bundles
+fluxos_web_*/
+fluxos_kml_*/
+.fluxos_tile_cache/
+
+# Python caches
+__pycache__/
+*.pyc
+
+# Generated reports from the preprocessing templates
+supporting_scripts/**/reports/
+
+# Cached DEM tiles downloaded by dem_download.py
+bin/dem_cache/
+
+# Local Claude Code / IDE state
+.claude/settings.local.json
+
+# JetBrains / IntelliJ / PyCharm project metadata
+.idea/
+
+# Sphinx build output — regenerate locally with `sphinx-build wikipage/source wikipage/build/html`
+wikipage/build/

.readthedocs.yaml

@@ -0,0 +1,21 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.13"
+
+# Build documentation in the "wikipage/source/" directory with Sphinx
+sphinx:
+   configuration: wikipage/source/conf.py
+
+# Python requirements for building documentation
+python:
+   install:
+   - requirements: wikipage/requirements.txt
+