Published technical guidance
Architecture explanations, discovery patterns, and implementation guidance.
Build workflows across independently operated infrastructure, connect a provider, or contribute to the shared contract.
Architecture explanations, discovery patterns, and implementation guidance.
Reusable software and examples developed in the DOE IRI GitHub organization.
Versioned specifications, RFCs, registries, profiles, and OpenAPI sources.
Begin with Getting Started and the workflow notebooks. The public hackathon exercises provide a repeatable discovery, submission, monitoring, and output-retrieval sequence.
Follow each provider's documentation for credentials, allocations, and supported operations. Use the deployed service description to understand the version and capabilities available to your workflow.
Read the Implementation Guide, map your resources to shared types and profiles, and connect provider-specific business logic through an adapter. The Hypermedia and Discovery guide explains how to advertise relationships and operations.
Use the Testbed page for experimentation context and meet the implementation community for collaboration.
The IRI 2.0 overview introduces the current development model. Follow the RFC Process and Contributing guide to turn implementation experience into proposed changes.
The FastAPI framework delegates provider-specific behavior to facility adapters. Configure the API groups your provider implements.
A Spring Boot implementation documenting read-only facility metadata, resources, incidents, events, sites, and locations. Consult its README for current endpoint coverage.
Per-domain example adapters with demonstration data provide a starting point for replacing behavior with provider integrations.
Python client tooling for compute workflows, with notebook examples and Airflow integration material in the repository.
Examples of authentication, filesystem operations, compute submission, and output collection, including the public hackathon suite.