Skip to content
Documentation for setting up OpenAPS
Branch: master
Clone or download
Pull request Compare This branch is 3259 commits behind openaps:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
scripts
source
.gitignore
Makefile
New-loop-stages-outline.md
OpenAPS_phase_visualization_Nov152015.png
README.md
SUMMARY.md
book.json
make.bat
reference-design.md
requirements.txt

README.md

Introduction

Welcome to the openaps documentation!

openaps is part of a set of development tools to support a self-driven Do-It-Yourself (DIY) implementation of an artificial pancreas based on the OpenAPS reference design. (Click here to view an image of the common physical components of an OpenAPS setup.)

By proceeding to use these tools or any piece within, you agree to the copyright (see LICENSE.txt for more information) and release any contributors from liability.

The tools may be categorized as:

  • monitor collecting data and operational status from devices, and/or aggregating as much data as is relevant into one place

  • predict make predictions about what will happen next

  • control enacting changes, and feeding more data back into the monitor, closing the loop

You may also find this flowchart helpful to further break down the areas of monitor, predict, and control into various stages of general setup; logging, cleaning, and analyzing data; building a manual system; automating your work; and iterating and improving.

A Note on DIY and the "Open" Part of OpenAPS

This is a set of development tools to support a self-driven DIY implementation. Any person choosing to use these tools is solely responsible for testing and implementing these tools independently or together as a system.

The DIY part of OpenAPS is important. There are very good reasons why this isn't a single downloadable script. While formal training or experience as an engineer or a developer is not a prerequisite, a growth mindset is required to learn to work with the "building blocks" that will help you develop your OpenAPS instance. Remember as you consider this project that this is not a "set and forget" system; and OpenAPS implementation requires diligent and consistent testing and monitoring to ensure each piece of the system is monitoring, predicting, and controlling as desired. The performance and quality of your system lies solely with you.

This community of contributors believes in "paying it forward," and individuals who are implementing these tools are asked to contribute by asking questions, helping improve documentation, and contributing in other ways.

OpenAPS System Development Phases

This documentation is organized into a series of phases that progressively build upon the openaps development tools towards a working OpenAPS system. Click here for a visualization and breakdown of the phases. The phases are as follows:

At the beginning of each phase, an outline summarizes:

  • Upon Completion—The capabilities that the user and system should have after completing the phase

  • Phase Tasks—Tasks or steps to take during the phase

  • Community Contribution—How users should be able to contribute to the #OpenAPS project and/or openaps development tool set during and after the phase

Summary

You can’t perform that action at this time.