Integrated Research Infrastructure (IRI)
The U.S. Department of Energy's Integrated Research Infrastructure (IRI) is an effort to seamlessly and securely integrate DOE experimental and scientific user facilities, data resources, and advanced computing systems into cross-facility scientific workflows that accelerate discovery.
AmSC leverages the IRI Facility API: a shared, standardized interface for interacting with participating high-performance computing facilities. The API is designed to expose common facility capabilities such as status, account, compute, filesystem operations, and more through a consistent programmatic interface.
For researchers, this means workflows can discover resources, stage or inspect files, submit jobs, and retrieve results across facilities without having to learn every center's native interface first.
Using IRI API Through AmSC Interfaces
The AmSC Interfaces page describes the web portal, REST APIs, and Python client available to AmSC users. The AmSC Python client supports resource discovery, remote job submission, and filesystem access across supported facilities through the IRI API.
Start there if you need to:
- Install the AmSC Python client.
- Understand authentication requirements for AmSC-hosted services.
- Find tutorial notebooks for ALCF, NERSC, and filesystem workflows.
For a task-oriented introduction, see Run Your First Job, which links the AmSC Python client setup to IRI job submission.
IRI workflows require an account at the target facility, an active allocation or project, and access to that facility's IRI API endpoint. Authentication and supported resources can vary by facility. Review the facility-specific resources below for access instructions and local requirements.
IRI Resources
The IRI GitHub hosts the shared specifications, reference implementations, tooling, and examples for the IRI Facility API:
- DOE IRI GitHub organization
- IRI Facility API Python Reference Implementation
- IRI Facility API Docs
- IRI Facility API Examples
- IRI Facility API Toolkit
Use the shared IRI resources when you need the common API model, example notebooks, or implementation-level details that are not specific to one facility.
Facility-Specific Resources
The IRI Facility API provides a standard interface across supported computing resources, but each facility has its own access policies, authentication requirements, and implementation details. Use the facility-specific pages below to learn more about the local API behavior.
| Facility | IRI API resources |
|---|---|
| ALCF | ALCF API documentation covers token setup, status, compute, filesystem, task, and account examples. The ALCF IRI API instance: https://api.alcf.anl.gov |
| ESnet | ESnet provides an IRI API endpoint deployed on the Cloud Services Platform (CSP). It supports the DOE IRI resource, account, and job-management interfaces and is intended for AmSC and partner integration testing. Access is authenticated through the AmSC identity layer. The ESnet IRI API instance: https://iri-dev.ppg.es.net |
| NERSC | NERSC API documentation covers NERSC facility API concepts, authentication, and examples. The NERSC IRI API instance: https://api.iri.nersc.gov/api/v2/ |
| OLCF | OLCF API documentation covers OLCF S3M API tokens and API reference material for status and compute. OLCF provides separate IRI instances for open and moderate security compute enclaves: • OLCF open compute enclaves (e.g. ACE Testbed): https://amsc-open.s3m.olcf.ornl.gov/ • OLCF moderate compute enclaves (e.g. Frontier): https://amsc-moderate.s3m.olcf.ornl.gov/ |
Tutorial Notebooks
The AmSC Python client tutorial repository includes facility-focused notebooks for workflows involving the IRI API:
Interested in getting involved?
Infrastructure partners and facilities interested in integrating with the IRI Facility API can contact the AmSC team through the AmSC support form.