Guides
These guides recover and curate workflow knowledge from the legacy notebooks
(00_data-prep.ipynb, 01a_run-tsa.ipynb, 01b_run-tsa.ipynb) archived in
reference/legacy_notebooks/, and align it with the current FEMIC CLI and
export modules.
- Pipeline Walkthrough
- Developer Environment Bootstrap (Fresh Clone)
- 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
- 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
- Rebuild Repro Contract
- How to Author a New Instance Rebuild Spec
- How to Interpret Rebuild Reports and Regressions
- Data Access Inventory
- 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
- Document Figure Recovery
- FreshForge Provider Integration
- TSR THLB Reconstruction Ladder
- GitHub + DataLad + Arbutus Pattern
- Windows Arbutus Auth Workflow
- Public Data Mirror Runbook
- Case Onboarding Template
- Stage 00: Data Prep and Inventory Conditioning
- 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
- BTC and FAN$IER Runtime and Extraction
- Model Input Bundle and Export Workflow
- Patchworks Variant and Scenario Management
- Diagnostics Interpretation Playbook
- Troubleshooting and Recovery Cookbook
- Known Limitations and Human-in-the-Loop Boundaries
- Patchworks Under Wine
- UBC VPN and License Connectivity
- Geospatial and Runtime Bootstrap
- Cross-Platform Runtime Smoke and Acceptance
- PyPI Release Runbook
- Legacy Notebook Traceability
- Sphinx Template Baseline