Welcome to popgen-npe’s documentation!

Contents:

• Installation
  • For uv users (faster)
  • For conda users
• Soup-to-Nuts Tutorial: Rate Landscape Estimation
  • Prerequisites
  • What we are building
  • Step 1: Write the simulator
  • Step 2: Configure the processor
  • Step 3: Write the config YAML
  • Step 4: Run the training workflow
  • Step 5: Run prediction on the example data
  • Step 6: Interpret the results
  • Next steps
• Usage
  • Basic Usage
  • Configuration Files
• Simulators
  • Overview
  • Base Simulator
  • Available Simulators
  • Usage in Configuration Files
  • Creating Custom Simulators
  • Technical Notes
• Processors
  • Overview
  • Processor Types
  • Configuration
  • Processor-Network Compatibility
  • Usage Examples
  • Custom Processors
  • Technical Notes
• API Reference
  • Tree Sequence Processors
  • Embedding Networks
• Contributing
  • Reporting Issues
  • Development Setup
  • Running Tests
  • Submitting Changes
  • Code Style

Indices and tables

• Index

• Module Index

• Search Page