[Researchers] Using mano

The mano library lets you write applications that interact with the Beiwe Research Platform. You can request lists of studies, users, device settings, and download files (with or without encryption). See the mano library main page for more instructions.

To use the library you need to set up a virtual Python environment. The instructions below are for getting this up and running on Mac OSX and Python 3.

Installing pipenv:

brew install pipenv
git clone https://github.com/harvard-nrg/mano.git
cd mano
pipenv install --skip-lock

Encrypting the keyring:

pipenv run crypt.py --encrypt ~/.nrg-keyring.json --output-file ~/.nrg-keyring.enc

To run mano in a Jupyter notebook, you need to do the following:

pipenv install ipykernel
pipenv shell
python -m ipykernel install --user --name=mano-ljsF42e9
jupyter notebook --notebook-dir=~/Dropbox/JP/beiwe

Here mano-ljsF42e9 is the name of the virtual environment, which is visible in the virtual environment shell prompt. That will change every time you run it. The final argument on the last line specifies the directory where the notebook will launch.