citysim-slurm

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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

• API version: 0.1.0
• Package version: 1.0.0
• Generator version: 7.14.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

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 citysim_slurm

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 citysim_slurm

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import citysim_slurm
from citysim_slurm.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = citysim_slurm.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
async with citysim_slurm.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = citysim_slurm.DefaultApi(api_client)
    job_id = 56 # int | 

    try:
        # Cancel
        api_response = await api_instance.cancel_cancel_job_id_get(job_id)
        print("The response of DefaultApi->cancel_cancel_job_id_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->cancel_cancel_job_id_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
DefaultApi	cancel_cancel_job_id_get	GET /cancel/{job_id}	Cancel
DefaultApi	create_create_name_get	GET /create/{name}	Create
DefaultApi	delete_delete_name_get	GET /delete/{name}	Delete
DefaultApi	run_run_name_get	GET /run/{name}	Run
DefaultApi	status_status_job_id_get	GET /status/{job_id}	Status
DefaultApi	version_health_get	GET /health	Version

Documentation For Models

• CitySimSlurmMessage
• CitySimSlurmStatus
• HTTPValidationError
• ValidationError
• ValidationErrorLocInner

Documentation For Authorization

Endpoints do not require authorization.

Author