nersc-iri

IRI facility API for NERSC.

For more information, see: https://iri.science/

<img src="https://iri.science/images/doe-icon-old.png\" height=50 /> <img src="https://www.nersc.gov/_resources/themes/nersc/images/NERSC_logo_no_spacing.svg\" height=50 />

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.19.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.nersc.gov/about/contact-us/

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import nersc_iri

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import nersc_iri

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import nersc_iri
from nersc_iri.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.iri.nersc.gov
# See configuration.py for a list of all supported configuration parameters.
configuration = nersc_iri.Configuration(
    host = "https://api.iri.nersc.gov"
)



# Enter a context with an instance of the API client
with nersc_iri.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = nersc_iri.AccountApi(api_client)
    name = 'name_example' # str |  (optional)
    modified_since = '2026-02-21T12:00:00Z' # datetime |  (optional)
    offset = 0 # int |  (optional) (default to 0)
    limit = 100 # int |  (optional) (default to 100)

    try:
        # Get the list of capabilities
        api_response = api_instance.get_capabilities(name=name, modified_since=modified_since, offset=offset, limit=limit)
        print("The response of AccountApi->get_capabilities:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccountApi->get_capabilities: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.iri.nersc.gov

Documentation For Models

• AllocationEntry
• AllocationUnit
• Capability
• CompressionType
• Container
• Event
• Facility
• Incident
• IncidentType
• Job
• JobAttributes
• JobSpecInput
• JobSpecOutput
• JobState
• JobStatus
• PostCompressRequest
• PostCopyRequest
• PostExtractRequest
• PostFileSymlinkRequest
• PostMakeDirRequest
• PostMoveRequest
• Problem
• Project
• ProjectAllocation
• PutFileChmodRequest
• PutFileChownRequest
• Resolution
• Resource
• ResourceSpec
• ResourceType
• Site
• Status
• Task
• TaskCommand
• TaskStatus
• TaskSubmitResponse
• UserAllocation
• VolumeMount

Documentation For Authorization

Authentication schemes defined for the API:

HTTPBearer

• Type: Bearer authentication

Author