2 Quick Guide

⚡ Quick Reference

Quick Guide: How the Manuals Work Together

Overview

The Fluvial Geomorphology Technical Manual and User Manual are companion documents designed to work together. Think of them as the “why” and “how” of fluvial geomorphic assessment.

The Two-Manual System

📐 Technical Manual: The Science

Purpose: Explains the scientific methods, theories, and calculations

Use this when you need to: - Understand the underlying science - Learn calculation methodologies - Validate your approach - Explain methods to reviewers - Understand why certain procedures are used

Contains: - Theoretical foundations - Mathematical equations - Classification systems (e.g., Rosgen) - Method validation and limitations - Scientific references

🔧 User Manual: The Practice

Purpose: Shows you how to use the tools and execute workflows

Use this when you need to: - Perform actual analyses - Follow step-by-step procedures - Use ArcGIS Pro and R tools - Process field data - Generate reports and outputs

Contains: - Software tutorials - Workflow procedures - Tool-specific instructions - Example datasets - Troubleshooting tips

⚡ Quick Reference

This is a test of a coding book icon:

How They Connect

📐 Technical Manual

WHY & WHAT

Theory
Equations
Methods
Validation

🔧 User Manual

HOW & WHEN

Workflows
Software steps
Examples
Troubleshooting

↓

✅ Your Successful Analysis

Typical Workflow

1. Planning Phase

📐 Technical Manual: Review methods for your stream type
🔧 User Manual: Check data requirements and tool setup

2. Field Work

📐 Technical Manual: Understand what measurements are needed and why
🔧 User Manual: Follow field data collection protocols

3. Data Processing

🔧 User Manual: Execute workflows in ArcGIS Pro and R
📐 Technical Manual: Reference when you need to understand a calculation

4. Analysis

🔧 User Manual: Run analysis tools
📐 Technical Manual: Interpret results using scientific context

5. Quality Control

📐 Technical Manual: Validate results against expected ranges
🔧 User Manual: Use QC checklists

6. Reporting

📐 Technical Manual: Cite methods and equations
🔧 User Manual: Generate standard outputs

Example: Calculating Bankfull Discharge

Technical Manual Shows:

Why: Manning’s equation is appropriate for uniform flow
What: Q = (1/n)AR^(2/3)S(1/2)
Theory: Relationship between flow, roughness, and geometry
Limitations: Assumes uniform flow conditions
Validation: Typical ranges for different stream types

User Manual Shows:

How: Step-by-step in ArcGIS Pro and R
Where: Which tools to click
When: At what stage in the workflow
Troubleshooting: Common errors and solutions
Output: What the final report looks like

Using Both Together:

📐 Read Technical Manual to understand Manning’s equation
🔧 Follow User Manual to input your cross-section data
🔧 Run the FluvialGeomorph tool
📐 Check Technical Manual to verify results are reasonable
🔧 Use User Manual to generate final report

Quick Reference Table

I Need To…	Use This Manual	Section
Understand Rosgen classification	📐 Technical	Stream Classification
Run classification in ArcGIS	🔧 User	Workflow Chapter
Learn about hydraulic geometry	📐 Technical	Hydraulic Geometry
Calculate width/depth ratios	🔧 User	Analysis Tools
Understand sediment transport equations	📐 Technical	Sediment Transport
Process LiDAR data	🔧 User	Data Preparation
Validate my discharge calculation	📐 Technical	Quality Control
Troubleshoot an error message	🔧 User	Troubleshooting
Cite methods in a report	📐 Technical	References
Generate cross-section plots	🔧 User	Visualization Tools

User Pathways

🟢 Beginner Path

Start: 🔧 User Manual - Getting Started
Learn: 📐 Technical Manual - Basic Concepts
Practice: 🔧 User Manual - Tutorial with example data
Understand: 📐 Technical Manual - Method details
Apply: 🔧 User Manual - Your own project

🟡 Intermediate Path

Review: 📐 Technical Manual - Specific method
Execute: 🔧 User Manual - Corresponding workflow
Validate: 📐 Technical Manual - Expected results
Refine: 🔧 User Manual - Advanced options

🔴 Advanced Path

Deep dive: 📐 Technical Manual - Theory and equations
Customize: 🔧 User Manual - Advanced workflows
Validate: 📐 Technical Manual - Sensitivity analysis
Innovate: Adapt methods for unique situations

When to Use Which Manual

Use Technical Manual When:

✅ Writing a methods section for a report
✅ Explaining your approach to reviewers
✅ Understanding why a method works
✅ Determining if a method is appropriate
✅ Validating results
✅ Teaching concepts to others
✅ Researching alternative approaches

Use User Manual When:

✅ Setting up software for the first time
✅ Following a step-by-step workflow
✅ Troubleshooting an error
✅ Learning tool-specific procedures
✅ Processing data
✅ Generating outputs
✅ Finding example datasets

Use Both When:

✅ Starting a new project
✅ Learning a new analysis method
✅ Quality checking your work
✅ Training team members
✅ Developing standard operating procedures

Cross-References

Both manuals include cross-references to help you navigate:

In Technical Manual: > “For step-by-step instructions on running this analysis, see User Manual Chapter 5: Hydraulic Geometry Analysis”

In User Manual: > “For the theoretical basis of this calculation, see Technical Manual Section 3.2: Manning’s Equation”

Tips for Success

📚 First Time Users

Skim both manuals to understand the structure
Start with User Manual tutorials using example data
Reference Technical Manual when you want deeper understanding
Bookmark frequently used sections in both

🎯 Experienced Users

Use Technical Manual as a reference guide
Use User Manual for workflow reminders
Contribute feedback to improve both manuals

👥 Team Leaders

Assign Technical Manual reading for conceptual training
Use User Manual for hands-on training sessions
Create project-specific SOPs combining both manuals

Getting Help

If You’re Stuck:

Check User Manual troubleshooting section
Review Technical Manual to ensure method is appropriate
Verify you’re using the right tool for your stream type
Consult example datasets to compare
Contact support with specific questions

When Reporting Issues:

Include information from both manuals: - Method used (from Technical Manual) - Tool/workflow (from User Manual) - Expected vs. actual results - Error messages

Document Versions

Always ensure both manuals are from the same version release: - Technical Manual v1.2.0 ↔︎ User Manual v1.2.0 ✅ - Technical Manual v1.2.0 ↔︎ User Manual v1.0.0 ⚠️ (may have inconsistencies)

Check the version number on the title page of each manual.

Summary

Manual	Focus	When to Use	Key Content
📐 Technical	Science & Theory	Understanding WHY	Methods, equations, validation
🔧 User	Practice & Application	Doing the work	Workflows, tools, examples
🤝 Together	Complete Solution	Best results	Informed analysis with proper execution

Remember: The Technical Manual gives you the knowledge; the User Manual gives you the skills. Together, they give you expertise.