Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
Climate Health 1.1.0 documentation
Climate Health 1.1.0 documentation

Contents

  • Using Chap Core with DHIS2 Modeling App
    • Configure DHIS2 Modeling App and Chap Core to work together
  • Documentation for model developers
    • Chap’s native connection to DHIS2 and the DHIS2 Modelling App
    • Examples of chap evaluate commands
    • Describing your model in our yaml-based format
    • Documentation for experienced modellers
    • Introduction to principles of spatiotemporal modelling and streamlined implementation of models through Chap
    • (to be updated) Developing your own custom model with CHAP
    • Running models through Chap
    • Running models through the Chap command-line interface
    • Evaluating your model side-by-side with a range of other models
    • Chap’s broad range of supporting functionality for modelling
    • Making chap-compatible train and predict endpoints
    • Running models with chapkit
  • Using the CLI Tool
    • Setting up CHAP-Core CLI Tool
    • CHAP Core Credentials for Google Earth Engine
    • Use JSON-file from DHIS2 Modeling App with CHAP Core CLI
    • Running on JSON Data Downloaded from the DHIS2 Modeling App
  • Contributor guide
    • Contributor getting started
    • Setting Up CHAP Core as a Contributor
    • Important note for Windows contributors
    • Code overview
    • Vocabulary (domain specific terms used in the code)
    • Testing while developing
    • Writing and building documentation
    • Creating a docker image for R models
    • Introduction to Development Tools
  • Chap REST API
    • Using Chap REST API
    • Setting up Chap REST-API locally
  • Releases and Future Plans
Back to top
View this page

Using Chap REST API¶

NOTE: The documentation about how the REST-API is working is limited.

There are two main ways to setup the CHAP REST-API:

  • For local testing purposes, the easiest way is to setup the CHAP REST-API locally with Docker

  • For using Chap in a production environment, it’s recommended to instead follow the instructions for setting up the CHAP REST-API on a server

Next
Setting up Chap REST-API locally
Previous
Chap REST API
Copyright © CHAP
Made with Sphinx and @pradyunsg's Furo