Skip to content

Home

Jump to bottom Edit New page
Eli Jones edited this page Mar 22, 2021 · 55 revisions

Beiwe Documentation

  • Deployment instructions for individual servers: How to set up your own Beiwe deployment on Amazon Web Services as a single server.

  • Deployment instructions for a scalable Beiwe Cluster (recommended): Somewhat more complex than the single server AMI, but strongly recommended.

  • Generate Firebase Push Notifications for your Beiwe Server. These credentials are necessary to use advanced scheduling features. Note that study participants who registered before these credentials are present will need to re-register.

  • Extra deployment instructions for non-IT-users: Complementary guide to Deployment instructions with extra help materials for non-IT-users setting up Beiwe (single server or cluster of servers) for the first time.

  • Help! I'm Trying to Deploy and Something's Going Wrong!: A periodically updated list of actions that system administrators will have to take in order to upgrade to newer versions of the Beiwe Backend.

  • How to Run Beiwe Locally: Directions for setting up to run the Beiwe Backend codebase on your computer. This can be either totally locally or hooked into a live Beiwe cluster deployment for debugging.

  • Upgrading from Python 2 to 3: Instructions on how to update a scalable Beiwe cluster from Python 2.7 to 3.6.

  • Android Data Upload: Details on how the Beiwe Android app creates data files and uploads them to the server.

  • Data batching and indexing details: Description of what Beiwe does to raw data files (uploaded from the Android and iOS apps) to sort data by timestamp, reformat columns, etc. This happens before the Data Analysis Pipeline runs.

  • Scalability: Description of Beiwe's server architecture and how that architecture is designed for scalability and downtime tolerance.

  • Android missing data investigation and fixes: Description of what we did in March 2018-May 2018 to investigate the problems of missing data and missing survey notifications on Android phones. Includes explanations of what we believe the root causes were, what we looked at, what we fixed, and what we didn't fix.

  • App Markdown support: Some customizable text in the Android and iOS apps (mainly the text of survey questions) can be formatted using Markdown syntax. This page describes which text boxes support formatting and how to use Markdown within Beiwe.

  • Survey JSON spec: Specification for how the web app saves surveys as JSON files and transmits them to the app.

Add a custom footer
Add a custom sidebar
Clone this wiki locally