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 mean and how they are used in both manuals.
Legend:
Skill Levels:
π’ Beginner
π‘ Intermediate
π΄ Advanced
Topic Classifications:
β‘ Quick Reference
ποΈ Resource
π Theory
π§ Practical
β οΈ Caution
βοΈ Evaluate
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 contents to pay special attention to based on need or common errors.
- Evaluate notes parts that cover evaluating application inputs and outputs.
How the Manuals Work Together
Two complementary resources for complete understanding and implementation
Technical Manual
WHY & WHAT
The scientific foundation
Fluvial geomorphology principles, regional curves, hydraulic geometry
Mathematical formulations, statistical methods, calculation procedures
Data collection standards, analysis techniques, quality control
Uncertainty analysis, error assessment, confidence intervals
Use when you need to:
β’ Understand the science
β’ Justify your approach
β’ Interpret results
β’ Explain to stakeholders
User Manual
HOW & WHEN
Practical implementation
Detailed procedures, decision trees, process flowcharts
R package functions, parameter settings, code examples
Real-world case studies, sample datasets, expected outputs
Common errors, solutions, FAQs, best practices
Use when you need to:
β’ Run an analysis
β’ Follow a workflow
β’ Solve a problem
β’ Learn the software
When used together, they provide complete understanding and capability
Your Successful Analysis
Understanding why + Knowing how
= Confident, Defensible Results
π‘ Recommended Workflow
Understand the concepts, theory, and scientific basis for your analysis
Follow step-by-step instructions to implement the methods in your project
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:
- π 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.
Quick Start Checklist
Ready to begin? Start with the User Manualβs βGetting Startedβ chapter, and keep the Technical Manual open for reference!