General Server State

connect()

Creates a server object that can be passed into other functions for making requests to the PEcAn API

ping()

Pings the PEcAn API server to see if it is live

get.status()

Gets general information about PEcAn & the details of the database host

Searching & Retrieving PEcAn Data

search.models()

Search for PEcAn Models from the database

get.model()

Get details of PEcAn Model from the database using model id

search.sites()

Search for PEcAn Sites from the database

get.site()

Get details of PEcAn Site from the database using site id

search.pfts()

Search for PEcAn PFTs from the database

get.pft()

Get details of PEcAn PFT from the database using PFT id

search.formats()

Search for PEcAn Models from the database

get.format()

Get details of PEcAn Model from the database using model id

search.inputs()

Search for PEcAn Models from the database

download.input()

Download & save the desired input file

PEcAn Workflows

get.workflows()

Get list of PEcAn Workflows from the database

get.workflow()

Get the details of a particular PEcAn workflow using the workflow ID

submit.workflow()

Submit a PEcAn workflow using various user-defined parameters Hits the POST /api/workflows/ API endpoint.

submit.workflow.xml()

Submit an XML file as a PEcAn workflow & obtain the workflow_id

submit.workflow.json()

Submit a JSON file as a PEcAn workflow & obtain the workflow_id

submit.workflows.csv()

Submit a bunch of PEcAn workflows, the details of which are mentioned in CSV file

get.workflow.status()

Get the status of a particular PEcAn workflow using the workflow ID

download.workflow.file()

Download & save the desired file for a workflow

PEcAn Runs

get.runs()

Get list of PEcAn Runs that belong to a specific workflow

get.run()

Get the details of a particular PEcAn run using the run ID

download.run.input()

Download & save the desired input file for a run

download.run.output()

Download & save the desired output file for a run

plot_run_vars()

Plot the desired variables from the results of a PEcAn run

Internal Functions

get.model.id()

Get the model ID from the exact name & revision

get.workflow.time.elapsed()

Get the time taken for a workflow to reach its current state from the time it started execution