1  Quick Guide

⚡ Quick Reference

2 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

🏷 Content Breakdown

Purpose: Shows you what the badges/tags and icons mean and how they are used in both manuals.

Legend:

Skill Levels:

• 🟢 Beginner

• 🟡 Intermediate

• 🔴 Advanced

Topic Classifications:

• ⚡ Quick Reference

• 📚️ Resource

• 🔬 Theory

• 🪛 Practical

• ⚠️ Caution

• ☑️ Evaluate

Icon Types:

• 🧰 Toolset
• 🗺️ Map Layer
• 🗃️ File Location
• 📁 Folder
• 🛠️ Tool
• 📊 Parameter
• 🧮 Value
• 📑 Reports
• 📄 File
• 📜 Script
• 📈 Spreadsheet

Uses:

• Skill levels are set by proficiency level of GIS skills and concept understanding.
  
  
  
  
  

• Topic classifications are based on the following:

  • References provide extensive information and explanation of the material in the manuals.
  • Resources provides a breakdown of icons, classifications, and how the 2 manuals work together.
  • Theory provides background on the sources and methods used in the tools and process.
  • Practical labels the application-based portions of the manuals.
  • Caution marks content to pay special attention to based on need or common errors.
  • Evaluate notes parts that cover evaluating application inputs and outputs.
    

• Icon types are to identify key items within the context of the manual:

  • 🧰 Toolset – A group of related tools (for example, ArcGIS toolsets) referenced in workflows.
  • 🗺️ Map Layer – Layers in a map or project (feature classes, rasters, rasters, etc.).
  • 🗃️ File Location – Folders or directory paths where data, projects, and outputs are stored.
  • 📁 Folder – A specific folder used in examples for organizing project data.
  • 🛠️ Tool – Individual geoprocessing or analysis tools used in the manuals.
  • 📊 Parameter – Inputs or options within tools that you configure for a given run.
  • 🧮 Value – Example settings, numeric values, or choices used for parameters or outputs.
  • 📑 Reports – Generated report products (tables, summaries, documents) used to review results.
  • 📄 File – Individual data or project files (e.g., .gdb, .tif, .shp, .csv).
  • 📜 Script – Code or scripts (e.g., Python) used to automate or extend workflows.
  • 📈 Spreadsheet – Data tables or worksheets (e.g., Excel) used for analysis or reporting.

---

How the Manuals Work Together

Two complementary resources for complete understanding and implementation

📐

Technical Manual

WHY & WHAT

The scientific foundation

🔬 Theory & Concepts

Fluvial geomorphology principles, regional curves, hydraulic geometry

🔢 Equations & Algorithms

Mathematical formulations, statistical methods, calculation procedures

🔎 Methods & Approaches

Data collection standards, analysis techniques, quality control

✓ Validation & Accuracy

Uncertainty analysis, error assessment, confidence intervals

Use when you need to:
• Understand the science
• Justify your approach
• Interpret results
• Explain to stakeholders

📖 Open Technical Manual →

🔧

User Manual

HOW & WHEN

Practical implementation

📋 Step-by-Step Workflows

Detailed procedures, decision trees, process flowcharts

💻 Software Instructions

R package functions, parameter settings, code examples

🪛 Practical Examples

Real-world case studies, sample datasets, expected outputs

🔨 Troubleshooting Tips

Common errors, solutions, FAQs, best practices

Use when you need to:
• Run an analysis
• Follow a workflow
• Solve a problem
• Learn the software

📖 Open User Manual →

↓

When used together, they provide complete understanding and capability

✅

Successful Analysis

Understanding why + Knowing how
= Confident, Defensible Results

💡 Recommended Workflow

1️⃣

Start with Technical Manual

Understand the concepts, theory, and scientific basis for your analysis

→

2️⃣

Apply with User Manual

Follow step-by-step instructions to implement the methods in your project

→

3️⃣

Reference Both

Switch between manuals as needed for interpretation and troubleshooting

---

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:

1. 📐 Read Technical Manual to understand Manning’s equation
2. 🔧 Follow User Manual to input your cross-section data
3. 🔧 Run the FluvialGeomorph tool
4. 📐 Check Technical Manual to verify results are reasonable
5. 🔧 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

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

🟡 Intermediate Path

1. Review: 📐 Technical Manual - Specific method
2. Execute: 🔧 User Manual - Corresponding workflow
3. Validate: 📐 Technical Manual - Expected results
4. Refine: 🔧 User Manual - Advanced options

🔴 Advanced Path

1. Deep dive: 📐 Technical Manual - Theory and equations
2. Customize: 🔧 User Manual - Advanced workflows
3. Validate: 📐 Technical Manual - Sensitivity analysis
4. 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

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

🎯 Experienced Users

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

👥 Team Leaders

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

---

Getting Help

If You’re Stuck:

1. Check User Manual troubleshooting section
2. Review Technical Manual to ensure method is appropriate
3. Verify you’re using the right tool for your stream type
4. Consult example datasets to compare
5. 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.

---

Quick Start Checklist

• Download both manuals
• Verify versions match
• Review this guide
• Identify your user level (Beginner/Intermediate/Advanced)
• Follow your pathway
• Bookmark key sections in both manuals
• Download example datasets from User Manual
• Review relevant methods in Technical Manual
• Execute first workflow from User Manual
• Validate results using Technical Manual

---

Ready to begin? Start with the User Manual’s “Getting Started” chapter, and keep the Technical Manual open for reference!