Complete documentation for the env-agents environmental data integration framework
New to env-agents? Start here:
- Installation Guide - Set up the framework
- Quick Start - Your first query in 5 minutes
- API Reference - Complete API documentation
- Services Guide - All 16+ supported data sources and their capabilities
- Credentials Setup - Configure API keys for services that require authentication
- API Reference - Detailed API documentation with examples
- Adding New Services - How to create adapters for new data sources
- Local Development - Set up your development environment
Running env-agents in production:
- Database Management - Managing SQLite databases, clearing data, checking status
- Pangenome Pipeline - Production pipeline for 16 services across 4,789 clusters
- Earth Engine Operations - Quota management, timeout handling, temporal fallback
For contributors and developers:
- Architecture - System design and component overview
- Local Development - Development environment setup
- Lessons Learned - Best practices from production optimization
Detailed guides for specific data sources:
- MODIS Land Cover - Interpreting MODIS MCD12Q1 categorical data
- USGS NWIS - Stream gauge data and parameter codes
- Jupyter Notebooks - Interactive demonstrations
- Example Scripts - Common usage patterns
- Test Suite - Running and writing tests
- Contributing Guidelines - How to contribute to the project
- Historical Documentation - Archived docs from previous versions
- Get environmental data → Start with Quick Start
- Add a new data source → See Extending Services
- Run the production pipeline → See Pangenome Pipeline
- Fix Earth Engine quota errors → See Earth Engine Operations
- Understand the data schema → See API Reference
- Set up API credentials → See Credentials Setup
- Contribute code → See Contributing Guidelines
docs/
├── README.md # ← You are here
├── INSTALLATION.md # Setup guide
├── QUICK_START.md # 5-minute tutorial
├── API_REFERENCE.md # Complete API docs
├── SERVICES.md # All data sources
├── EXTENDING_SERVICES.md # Adding adapters
├── CREDENTIALS.md # API key setup
│
├── operations/ # Production operations
│ ├── DATABASE_MANAGEMENT.md
│ ├── PANGENOME_PIPELINE.md
│ └── EARTH_ENGINE_NOTES.md
│
├── adapters/ # Adapter-specific docs
│ ├── MODIS_LANDCOVER.md
│ └── USGS_NWIS.md
│
├── development/ # Developer docs
│ ├── ARCHITECTURE.md
│ ├── LOCAL_DEVELOPMENT.md
│ └── LESSONS_LEARNED.md
│
└── archive/ # Historical docs
└── README.md
Questions or issues? Check Contributing Guidelines or open an issue on GitHub.