-
Notifications
You must be signed in to change notification settings - Fork 46
Home
If you find a mistake, would like wiki editing privileges, or have identified any other potential issue with the documentation you find in this wiki please post an issue on the beiwe-backend issues page with a documentation tag, or you can email biblicabeiwe at gmail dot com.
Please make sure to include direct links to any pages you reference.
Are you a researcher or study administrator using the Beiwe platform? We merged the old wiki into this one to consolidate documentation in a single place.
-
Digital Phenotyping: Some basic concepts and ideas.
-
Beiwe Data Privacy and Security Manual: This manual reviews types of data collected and security measures in place on the Beiwe Research Platform.
-
Beiwe Research Administration Website Manual: This manual is for study staff to learn how to operate the Beiwe back end, set up surveys -and enroll patients.
-
Data Monitoring Using the Dashboard: Instructions on how to monitor your data quality.
-
Beiwe App Participant Manual for Android: This manual is for the installation and use of the Beiwe Android app.
-
Beiwe App Participant Manual for iOS: This manual is for the installation and use of the Beiwe iOS app.
-
Summary Statistics: Summary statistics examples and descriptions.
-
Beiwe Troubleshooting and FAQs: Common troubleshooting solutions.
-
Using mano: Library for writing applications that interact with the Beiwe Research Platform.
-
Passive Data: Passive data descriptions, with examples, collected by Beiwe.
-
Active Data: Active data descriptions, with examples, collected by Beiwe.
-
Supported Data Streams: Support data steams based on operating system.
-
API for Tableau, which provides Forest-output Summary Statistics and Data Quantity Statistics
-
Extra deployment instructions for non-IT-users: Complementary guide to Deployment instructions for a scalable Beiwe Cluster with extra help materials for non-IT-users setting up Beiwe.
-
Advanced Configuration Options for Beiwe web-facing servers and data processing servers.
-
Tips For Local Beiwe Development: Further 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 3.6 to 3.8: The Python 3.8 update requires deploying and swapping to a new Elastic Beanstalk Environment technology stack, directions are here. (Relevant if your environment existed before January 2022.)
-
Adding Forest to your deployment
-
Celery troubleshooting for problems with data download/data processing, sending push notifications, or running Forest
-
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.
- Credential setup for 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.
- Data Download API for raw/batched data
-
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.