femic

Guides

  • Guides
    • Pipeline Walkthrough
      • Purpose
      • End-to-End Flow
      • Stage Boundaries
      • Key Assumptions
      • Operator Interpretation Callouts
      • Primary Sources
    • Developer Environment Bootstrap (Fresh Clone)
      • Purpose
      • Copy-Paste Bootstrap Scripts
      • 1) Create and activate a local .venv
      • 2) Install editable dev dependencies
      • 3) Verify runtime tools are available
      • 4) Initialize submodules and materialize annex data
      • 5) Export the external data root and run preflight
      • Related Guides
    • VS Code and Coding-Agent Onboarding
      • Purpose
      • Use This Guide For
      • Minimum Local Setup
      • Windows VS Code/Codex Recovery: Broken Local File Links
      • VS Code Workspace Basics
      • What the Coding Agent Is Good At
      • What Still Needs Human Supervision
      • Prompting Style That Works Well
      • Scoping Rules for Large Tasks
      • Recommended Human Review Loop
      • GitHub Issue Workflow Hygiene
      • FEMIC-Specific Things to Watch For
      • Current Proprietary-Tool Seams
      • Patchworks Overlay Reminder
      • Suggested First Session for a New Contributor
      • Patchworks model rule of thumb
      • Looking Ahead
      • Related Guides
    • Deployment Instance Setup
      • Create an Instance
      • Visible User Workspace Root
      • Canonical In-Repo Reference Instance (Maintainers)
      • BC VRI Auto-Download
      • Installed-Package Preflight Check
      • Instance Root Resolution
      • Registry-Backed Patchworks Variants
      • Canonical K3Z Example Instance Repository
      • Canonical TSA29 Example Instance Repository
      • Canonical TSA23 Example Instance Repository
      • AFRF Block Instance Repositories
      • Working With Bundled Example Instances Under external/
      • Bundled Example Instance Amend/Rebuild Loop
      • Parent Repo vs Submodule Repo
      • Contributor Baseline for New Instance Repositories
      • Reference Instance Release Gate Evidence
    • WBI AOI Instance Set (Phase 113)
      • Purpose
      • Structure (per instance)
      • Data lane
      • Repo creation / publication flow (maintainer)
      • Per-MU model-build graphs
      • Verification
    • Rebuild Repro Contract
      • Purpose
      • Contract Sources
      • Expected Operator Workflow
      • Required Evidence Artifacts
      • Failure Classes
      • Contributor Policy (Mandatory for New Instance Repos)
      • Next Guides
    • How to Author a New Instance Rebuild Spec
      • Purpose
      • Start from Template
      • Core Sections
      • Minimal Copy-Ready Example
      • Step Authoring Rules
      • Invariant Authoring Rules
      • K3Z Reference Pattern
      • Dry-Run and Execute
    • How to Interpret Rebuild Reports and Regressions
      • Report Location
      • Step Outcomes
      • Invariant Results
      • Baseline and Allowlist Diffs
      • Regression Gate
      • Evidence Trend Drift Across Releases
      • Triage Workflow
      • Common Patterns
    • Data Access Inventory
      • Authoritative Registry
      • Key Dataset Families
      • Checksum Policy
      • DataLad Mirror Scope
      • BC Data Catalogue Discovery
      • TSR Intelligence Workflow
    • Hydrology Domain And Receptor Contract
      • Purpose
      • Domain Manifest
      • Source Registry
      • Python Usage
      • Audit
      • Public-Data Boundary
      • See Also
    • Hydrology Data Bundles
      • Purpose
      • Bundle Layout
      • Build From A Domain
      • Plan And Gaps
      • Audit
      • Public Acquisition
      • Pilot Data Audit
      • DataLad And Arbutus
      • See Also
    • Hydrology Disturbance Ledger
      • Purpose
      • Ledger Contract
      • Inputs
      • CSV Handoff
      • Road State
      • Conservation
      • Recovery Semantics
      • Limits
      • See Also
    • Tier 0 Hydrology Screening Metrics
      • Purpose
      • Metrics
      • ECA Semantics
      • Road Metrics
      • Exposure Context
      • Regimes
      • Example
      • Outputs
      • Limits
      • See Also
    • Stochastic Flood-Frequency Response
      • Purpose
      • Frequency Models
      • Annual Maxima And POT
      • Stationary Fits
      • Paired Response
      • Nonstationary Response Surface
      • Uncertainty
      • Calibration And Validation
      • Limits
      • See Also
    • Process-Based Hydrology Model Adapters
      • Purpose
      • Model Boundaries
      • Scenario Manifest
      • Runtime Probing
      • Implemented Adapters
      • Running A Model
      • Normalized Outputs
      • External Runtime And Licensing
      • Limits
      • See Also
    • Surrogate Models For Hydrologic Response
      • Purpose
      • Design Of Experiments
      • Surrogate Families
      • Training And Validation
      • Applicability Domain And Refusal
      • Persistence
      • Limits
      • See Also
    • Hydrology Response Bundles
      • Purpose
      • Bundle Layout
      • Build A Bundle
      • Flood-Risk Table
      • Pinning And Consumer Read Order
      • Determinism And Audit
      • Limits
      • See Also
    • Hydrology Validation And P114 Closeout
      • Purpose
      • What Was Validated
      • Public Gauge Pilot
      • Tail Plausibility Failure
      • Published Benchmark Review
      • Pilot Readiness And Data Gaps
      • Uncertainty And Deviations
      • Model Card
      • WS4/FHOPS Handoff
      • Closeout Statement
      • Reproduce The Bounded Pilot
      • See Also
    • LidarBC Data-Product Discovery
      • Purpose
      • Ownership Boundary
      • Source Catalog
      • Direct Tile Layers
      • AOI Selection Contract
      • CLI Usage
      • Python Usage
      • Storage and Dependency Boundaries
      • Unsupported Sources
      • Next Steps
      • See Also
    • LidarBC Tile Materialization
      • Purpose
      • Managed Layout
      • Plan Or Preflight
      • Materialize
      • Resume Rules
      • Integrity And Completeness
      • Failure And Retry
      • Manifest Changes And Selection Pinning
      • DataLad And Arbutus
      • See Also
    • Terrain Raster And Slope Products
      • Purpose
      • Dependency Stack
      • Accepted Inputs
      • Slope
      • Point-Cloud Gridding
      • Zonal Statistics
      • QA Reports
      • Current Limits
      • See Also
    • Terrain-Derived Stream Candidates
      • Purpose
      • Workflow
      • Inputs
      • Parameters
      • Outputs
      • Comparison Metrics
      • Review Manifest And Caveats
      • Limitations
      • See Also
    • Native Canopy And Precision-Forestry Products
      • Purpose
      • CHM From DSM And DEM
      • Canopy Structure
      • VRI Comparison And Uncertainty
      • Individual Tree Products
      • TFL 6 Pilot Evidence
      • Limitations
      • See Also
    • LidarBC Product Bundles
      • Purpose
      • Bundle Layout
      • Build From A Selection
      • Manifest Contract
      • Reproducibility And Pinning
      • Validation
      • WS4 P43 And FHOPS P13 Consumer Contract
      • Shared TFL 6 Bundle Validation
      • Storage And Delivery
      • Bounded AOI Fixture
      • Next Steps
      • See Also
    • LiDAR ground-bundle reader
      • Build a bundle
      • Near-surface ground
      • Validate a bundle
      • Skip LAZ inspection
      • Install optional inspection
      • Large tiles and local crop
      • Summarize by polygon
      • Python
      • Validation evidence
      • Limits
    • Inventory ALS Predictions
      • Prerequisites
      • Run
      • Point-cloud grid features
      • Local CWH pilot
      • Published transfer benchmark
      • Fixture
      • Validation
      • Limits
    • INV-01 TSA 23 Full Run
      • Architecture
      • Runbook
      • Results and limits
      • See Also
    • INV-01 TSA 23 Validation and Gap Analysis
      • VRI screening
      • PSP holdout: use the archive now
      • Model-status mask
      • Regional calibration using the full open-data stack
      • Omitted-tile gap
      • Recommendation
      • Reproduction
      • See Also
    • LiDAR Instance Integration
      • Purpose
      • Instance Layout
      • Instance Root Resolution
      • Recommended Workflow
      • TFL 6 Pilot Evidence
      • DataLad Boundary
      • Instance Handoff Checklist
      • See Also
    • BC Data Catalogue Discovery
      • Purpose
      • Minimal Workflow
      • Concrete Examples
      • Good-Citizen Guardrails
      • Worked Example: F_OWN to a Local GeoPackage
      • Batch Input from a Query File
      • PowerShell Notes
      • Classification Buckets
      • Service Automation Hints
      • AOI-Scoped WFS Fetch
      • DWDS / FGDB Fallback
      • Worked Example: TSA29 Query File to Local Layers
      • Manifest Output
      • Promotion Path
      • bcdata Attribution
      • Related References
    • TSR Intelligence Workflow
      • Purpose
      • Canonical vs Local Outputs
      • Minimal One-TSA Workflow
      • Reviewed Adoption Workflow
      • Worked Example: TSA29 Source Layers and THLB
      • Convergence And Reproducibility Contract
      • AOI Scope Guardrail
      • Windows PowerShell Notes
      • Using Extracted Source Layers with BCDC Discovery
      • Agent Workflow Notes
      • Current Boundaries
      • Related References
    • Site-Index Reconciliation Workflow
      • When to Use It
      • Inputs
      • Run It
      • Read the Summary
      • Interpretation Rules
      • TSA46 Pilot
      • Next Checks
    • Document Figure Recovery
      • Install
      • Corpus Layout
      • Prepare A Corpus
      • Register A Recovered Table
      • Review Gates
      • TFL 6 MP11 Pilot
    • FreshForge Provider Integration
      • Purpose
      • Install
      • Finding Available Workflows
      • Provider Discovery
      • Materialization Provider
      • Generic Workflow Example
      • Namespace-Aware Artifacts
      • Relationship To FEMIC Execution
      • Instance Workflow Ownership
      • Boundaries
      • API
    • fresh-vdyp integration
      • Install
      • Curve query
      • Bundle validation
      • Data prerequisites
      • Boundary
      • Known limits
      • Links
    • fresh-tipsy integration
      • Install
      • Adapter call
      • Data prerequisites
      • Optional test
      • Boundary
      • Known limits
      • Links
    • TSR THLB Reconstruction Ladder
      • Purpose
      • Why AFLB and THLB Matter
      • The Reconstruction Ladder
      • Current FEMIC Execution Modes
      • Fallback and Review Paths
      • Comparison Contract
      • THLB Accounting Directives
      • Worked TSA29 Read
      • How This Guide Fits the Other Docs
    • GitHub + DataLad + Arbutus Pattern
      • Short Version
      • What FEMIC Wraps Today
      • What Stays in Runbooks on Purpose
      • How Collaborators Normally Consume the Data
      • How the Coding Agent Fits In
      • How to Copy This Pattern into Another Project
      • If You Only Read 6 Files
      • Bottom Line
    • Windows Arbutus Auth Workflow
      • User-local files
      • Shared env contract
      • Profile registry
      • Status marker
      • Fresh bootstrap
      • Shell loading
      • Status checks
      • Relationship to prep validate-case
      • Instance publication vs public-data mirror
    • Public Data Mirror Runbook
      • Scope
      • Maintainer Workflow (Create/Publish Mirror Repo)
      • Collaborator Workflow (Clone/Get/Update)
      • Windows Notes
      • Acceptance Checks
    • Case Onboarding Template
      • Template Files
      • Onboarding Workflow
      • Required Input Checklist
      • Acceptance Criteria for Onboarded Case
      • K3Z Example Instance Baseline
      • TSA29 Example Instance Baseline
      • Working With a Local Coding Agent
    • Stage 00: Data Prep and Inventory Conditioning
      • Scope
      • Inputs
      • Core Processing Responsibilities
      • THLB interpretation note
      • Checkpoint Semantics
      • Assumptions
      • Outputs Consumed by Stage 01a
      • ArcRasterRescue Workflow Contract
      • Primary Legacy Notebook Coverage
    • Stage 01a: Strata, VDYP Curves, and TIPSY Input Generation
      • Scope
      • Key Workflow Steps
      • Selected-AU Curve-Family Contract
      • VDYP Fitting and SI Splits
      • TIPSY Input Boundary
      • Operator QA Checklist
      • Known Failure Signatures
      • Primary Legacy Notebook Coverage
      • K3Z Teaching Baseline Notes
      • Linux Source-Checkout Prerequisites
      • Known-Good Windows K3Z Hand-Off
      • Curve Rescue Guard
    • Stage 01b: Post-TIPSY Integration and Comparison
      • Scope
      • Required Input
      • Freshness guard
      • Core Responsibilities
      • Optional TSR Yield Assumptions
      • Interpretation Guide
      • Exit Criteria
      • Primary Legacy Notebook Coverage
      • Linux Source-Checkout Prerequisites
      • Known-Good Windows K3Z Resume Path
    • BTC and FAN$IER Runtime and Extraction
      • Purpose
      • BTC: Supported Unattended Runtime Seam
      • BTC /No_GUI Status
      • BTC Indicator Banks
      • FAN$IER: Tracked FEMIC Surfaces
      • Practical FAN$IER Lanes
      • Related References
    • Model Input Bundle and Export Workflow
      • Bundle Artifacts
      • AFLB Stand Universe and THLB/NTHLB Semantics
      • Selected-AU and Remap Semantics
      • Patchworks Export
      • Woodstock Export
      • ws3 Section Handoff
      • Dual-Fork Export (Patchworks + Woodstock + Optional ws3 Smoke)
      • Release Packaging Export
      • Assumptions
    • Carbon package workflow
      • Start here
      • Data flow
      • What belongs where
      • Stable page map
      • Production evidence
      • Boundaries
      • Related
    • Carbon Package Export
      • Prerequisites
      • Command
      • What it writes
      • Model choices in the first version
      • Validation
      • Caveats
      • Related
    • Fertilization Response and Emissions Audit
      • Public response data
      • Emissions audit
      • Materializing a fertilized curve
      • Current boundary
      • References
    • Harvested wood product lifecycle
      • Public assumptions
      • Accounting
      • What the model does not represent
      • Run it in WS4
      • Curve relationship
      • Related
    • GCBM walltowall Export
      • Prerequisites
      • Command
      • What it writes
      • Model choices
      • Disturbances
      • External smoke
      • Caveats
      • Related
    • Patchworks Variant and Scenario Management
      • Purpose
      • Registry Shape
      • Read-Only Inspection Flows
      • Materialization Consent Surface
      • Variant Launch Flows
      • Scenario Sets
      • User Overlay Management
      • Related References
    • Diagnostics Interpretation Playbook
      • Strata Diagnostics (strata-*.png)
      • VDYP Fit Diagnostics (vdyp_fitdiag_*.png)
      • TIPSY vs VDYP Overlays (tipsy_vdyp_*.png)
      • Escalation Path
    • Troubleshooting and Recovery Cookbook
      • Common Issues
    • Known Limitations and Human-in-the-Loop Boundaries
      • TIPSY Boundary
      • FAN$IER Boundary
      • Data Vendor/Format Constraints
      • Modeling Limitations
      • Documentation Scope Boundary
    • Patchworks Under Wine
      • Prerequisites
      • Config File
      • CLI Workflow
      • Generated Runtime Artifacts
      • Notes
    • UBC VPN and License Connectivity
      • Primary Topology
      • CLI OpenConnect Pattern
      • Diagnostic Steps
      • Failure Signatures
      • License Reachability Ownership
      • Fallback Path
    • Geospatial and Runtime Bootstrap
      • Why This Matters
      • Authoritative Platform Runtime Surfaces
      • Core Executables and Services
      • Windows Bootstrap Ritual
      • Linux Bootstrap Ritual
      • DataLad / git-annex Smoke Checks
      • Verify Runtime Readiness
      • Troubleshooting
    • Cross-Platform Runtime Smoke and Acceptance
      • Purpose
      • Platform-Specific Runtime Rituals
      • Windows Smoke Workflow
      • Linux Parity Workflow
      • Acceptance Criteria
      • What Should Match Across Platforms
      • What May Differ Across Platforms
      • Evidence to Keep
      • Related Guides
    • PyPI Release Runbook
      • Pre-release prerequisites
      • Packaging and deterministic wheel checks
      • Current known limitation
      • TestPyPI publication and smoke
      • Production PyPI publication
      • Post-release traceability checklist
      • Trusted publishing troubleshooting
    • Legacy Notebook Traceability
      • Coverage Inventory
      • Coverage Matrix Fields
      • Retired Guidance
      • Notebook Output Cleanup Policy
    • Sphinx Template Baseline
      • Canonical Reference
      • Required Baseline Components
      • Alignment Targets
      • K3Z Content-Depth Guardrail

Sample Models

  • Sample Models
    • K3Z Example Instance (Pointer)
      • Purpose
      • Canonical Student Docs
      • Standalone K3Z Coverage Map
      • Submodule Sync Commands
      • FEMIC-Local Integration Notes
    • TSA29 Example Instance (Pointer)
      • Purpose
      • Canonical Student Docs
      • Submodule Sync Commands
      • FEMIC-Local Integration Notes
    • MKRF Example Instance (Pointer)
      • Purpose
      • Runtime lane
      • Canonical MKRF Docs
      • Current Scope Boundary
      • Commercial thinning follow-up
      • Current v0 checkpoint signal
      • Submodule Sync Commands
      • FEMIC-Local Integration Notes
    • North Island Instance Pair
      • Shared inputs, separate runtimes
      • Use them together or separately
    • TFL 6 Teaching Instance (Pointer)
      • Purpose
      • Current Status
      • Canonical Student Docs
      • Standalone TFL 6 Coverage Map
      • Submodule Sync Commands
      • FEMIC-Local Integration Notes
      • Selected-AU Curve-Family Reminder
      • Publication Boundary
    • K3Z Metadata and Lineage
      • Scope
      • Inventory: Upstream Sources -> Model Artifacts
      • Build-Lineage Chain
      • Component-Level Notes
      • Provenance Versioning Policy
      • Acceptance Checklist for Lineage Updates
    • MKRF Metadata and Lineage
      • Scope
      • Current Artifact Families
      • Canonical Build-Lineage Chain
      • Retained PoC / Legacy Reference Chain
      • Accepted Benchmark Result
      • Current Boundary
      • Accepted Legacy-Only Seams

Reference

  • Technical Contracts
    • How to use this section
    • Contract Pages
      • Patchworks Model Semantics
      • Forest Carbon Domain and CBM Package Contract
      • Repo and Runtime Invariants
      • Instance and Data Roots
      • Instance Extension Boundaries
      • Stage Boundaries and Canonical Artifacts
      • Recovery and External Runtime Boundaries
      • Hydrology Domain Contract
      • Hydrology Data Bundle Contract
      • Hydrology Disturbance Ledger Contract
      • Tier 0 Hydrology Screening Contract
      • Flood-Frequency Response Contract
      • Process-Model Adapter Contract
      • Surrogate Model Contract
      • Hydrology Response Bundle Contract
      • Hydrology Validation And Closeout Contract
      • LiDAR Source and Tile-Index Contract
      • LiDAR Materialization Contract
      • LiDAR Terrain Product Contract
      • Terrain-Derived Stream Candidate Contract
      • Native Canopy And Tree Product Contract
      • LiDAR Product Bundle Contract
      • LiDAR ground-bundle contract
      • Inventory ALS Contract
      • Climate Contract (femic.climate.v1)
      • Climate Consumer
      • Disturbance Contract (femic.disturbance.v1)
      • EFI Model Card (femic.efi.model.v1)
      • EFI Model Application (femic.efi.coefficients.v1)
      • EFI Biomass Curve (femic.efi.biomass_curve.v1)
      • Site-Index Reconciliation (femic.site-index.reconciliation.v2)
  • LiDAR ground-classification validation
    • Evidence at a glance
    • What the evidence supports
    • What the evidence does not support
    • Strict versus terrain-surface ground
    • Public control data
    • Reproduction
    • Detailed reports
    • Licence and attribution
    • Arbor provenance
  • API Reference
    • API contract
    • How to use this reference
    • Current limitation
      • FEMIC Modules
  • CLI Reference
    • Top-Level Command
    • Options
    • Commands
    • Run
    • Document Ingestion
    • Pipelines
    • Prep
    • VDYP
    • TSA
    • LiDAR
    • TIPSY
    • Data
    • FAN$IER
    • Data
    • TSR
    • Export
    • Patchworks Runtime
    • Instance Workspace
      • hydrology commands
  • Patchworks Export Contract
    • Patchworks semantics guardrail
    • ForestModel XML requirements
    • Species-wise yield curves
    • Seral-stage attributes (optional)
    • Retention modulator (optional per fragment)
    • Fragments shapefile requirements
    • CLI usage
  • Woodstock Compatibility Export
    • CLI usage
  • Run Config Profile
    • Schema
    • Precedence
    • Compatibility note
    • Example
  • Nemora Task Map (Draft)
  • Nemora Upstream Candidates (Draft)
femic
  • Sample Models
  • View page source

Sample Models

Tracked sample models that students and collaborators can run directly from this repository.

  • K3Z Example Instance (Pointer)
    • Purpose
    • Canonical Student Docs
    • Standalone K3Z Coverage Map
    • Submodule Sync Commands
    • FEMIC-Local Integration Notes
  • TSA29 Example Instance (Pointer)
    • Purpose
    • Canonical Student Docs
    • Submodule Sync Commands
    • FEMIC-Local Integration Notes
  • MKRF Example Instance (Pointer)
    • Purpose
    • Runtime lane
    • Canonical MKRF Docs
    • Current Scope Boundary
    • Commercial thinning follow-up
    • Current v0 checkpoint signal
    • Submodule Sync Commands
    • FEMIC-Local Integration Notes
  • North Island Instance Pair
    • Shared inputs, separate runtimes
    • Use them together or separately
  • TFL 6 Teaching Instance (Pointer)
    • Purpose
    • Current Status
    • Canonical Student Docs
    • Standalone TFL 6 Coverage Map
    • Submodule Sync Commands
    • FEMIC-Local Integration Notes
    • Selected-AU Curve-Family Reminder
    • Publication Boundary
  • K3Z Metadata and Lineage
    • Scope
    • Inventory: Upstream Sources -> Model Artifacts
    • Build-Lineage Chain
    • Component-Level Notes
    • Provenance Versioning Policy
    • Acceptance Checklist for Lineage Updates
  • MKRF Metadata and Lineage
    • Scope
    • Current Artifact Families
    • Canonical Build-Lineage Chain
    • Retained PoC / Legacy Reference Chain
    • Accepted Benchmark Result
    • Current Boundary
    • Accepted Legacy-Only Seams
Previous Next

© Copyright .

Built with Sphinx using a theme provided by Read the Docs.