pamflow Logo

Getting Started

  • Installation instructions
    • 1. Install miniconda
    • 2. Install Git
    • 3. Clone the repository
    • 4. Install required packages
  • Beginner’s guide
    • The tutorial data
      • 1. Download tutorial data
      • 2. Audio recordings
      • 3. Field deployments sheet
      • 4. Target species list
    • Data preparation
      • Configure audio path and timezone
      • Move input files to the pamflow folder
      • Run the data preparation pipeline
    • Quality control
      • Run the quality control pipeline
      • Check deployment timeline
      • Check deployment locations
      • Check survey effort
      • Check audio outliers
      • Timelapses
    • Species detection
      • Detection outputs
      • Audio segments
      • Data annotation
      • Optional: Reviewing detections with the BirdNET GUI
        • Reviewing Detected Segments with the BirdNET GUI
        • Before You Start
        • Opening Segments in BirdNET
        • Validating Detections
    • Detection validation
      • Validation outputs
        • Results with the example annotations
      • Wrap-up

Diving deeper

  • Workflow structure and execution
    • Overview
    • Running the workflow
    • Pipeline details
      • 1. Data preparation
      • 2. Quality control
      • 3. Species detection
      • 4. Acoustic indices
      • 5. Graphical soundscape
      • 6. Detection validation
      • 7. Filter media
      • 8. Export
  • Expert’s Guide
    • Customize the acoustic indices to compute
      • 1. Enable or disable an index
      • 2. Change an index’s parameters
      • 3. Add a brand-new index (advanced)
    • Create a custom pipeline
      • 1. Generate the Pipeline
      • 2. Define your Logic in nodes.py
      • 3. Connect the Nodes in pipeline.py
      • 4. Register the Pipeline
      • 5. Verify and Run
      • Troubleshooting Tip: Check your Nodes
    • Multi‐Season Configuration
      • Directory Structure
      • 1. Set the Default Output Path
      • 2. Override per Season
      • 3. Configure Each Season
        • Field deployment spreadsheet
        • Update the catalog
        • Update the audio directory
      • 4. Run using environment
    • Using a Custom BirdNET-Trained Classifier
      • Prerequisites
      • 1. Prepare the Model Files
      • 2. Configure the Classifier Parameters
      • 3. Label Format Requirements
        • Important
      • 4. Geographic Filtering Behavior
      • 5. Running Species Detection
      • Troubleshooting
        • Invalid label format
        • Model and labels mismatch
        • No detections produced

Data standards

  • Input data standards
    • File organization
    • Field deployment sheet
    • Target species
  • Output data standards
    • Deployments
    • Media
    • Observations
    • References

Getting Involved

  • Contributing guidelines
    • Table of Contents
    • Getting Started
    • How to Contribute
    • Code Standards
    • Git Commit Names
    • Testing
    • Pull Request Process
    • Reporting Issues
  • Contributors
    • Core team
    • Contributors
    • How to be added
pamflow
  • Search

© Copyright 2025, pamflow developers.

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