Documentation

Introductory


What is it?
Answers Basic Questions

What are sleep and alertness models? What can I do with them? What is this website? What is the API?

Quick Start
Learn what you need to Try it out

Provides a brief introduction to using this web-application to generate sleep and alertness predictions.

Sleep & Alertness Models
Overview of the Concepts

Provides a general overview of mathematical models that predict sleep & alertness dynamics.

User Guides


Access Overview
General Access User Guide

Provides a general overview of accessing the models. This guide is common to both the programmatic and web-browser access.

Programmatic Access
REST (API) Access User Guide

Provides details specific to accessing the models using the RESTish API.

Browser Access
Web-Browser Access User Guide

Provides details specific to accessing the models using your web-browser.

Reference Guides


Model Inputs
Input Structure Reference

Reference guide describing the fields of the json-formatted text used to define the context in which a model is evaluated and the outputs to return.

Output Sets
Predefined Output-Sets Reference

Reference guide listing the predefined sets of output that can be requested and their equivalent output-config object.

Model Outputs
Output Structure Reference

Reference guide describing the fields of the json-formatted text that that is returned.