Skip to content

Files

Latest commit

9b997f9 · Aug 10, 2021

History

History
This branch is 4033 commits behind PecanProject/pecan:master.

api

PEcAn RESTful API Server

This folder contains the code & tests for PEcAn's RESTful API server. The API allows users to remotely interact with the PEcAn servers and leverage the functionalities provided by the PEcAn Project. It has been designed to follow common RESTful API conventions. Most operations are performed using the HTTP methods: GET (retrieve) & POST (create).

For the most up-to-date documentation, you can visit the PEcAn API Documentation.

Starting the PEcAn server:

Follow the following steps to spin up the PEcAn API server locally:

$ cd R
$ ./entrypoint.R

Running the tests:

$ ./test_pecanapi.sh