diff options
author | Pjotr Prins | 2021-05-14 14:09:48 -0500 |
---|---|---|
committer | Pjotr Prins | 2021-05-14 14:09:48 -0500 |
commit | 46a96ec0b89620eed4874ada565a9643ac19a042 (patch) | |
tree | 40a39956050a69484a56c9a9e170ae372a091d41 /README.md | |
parent | 09f699253400a807e2390e6515b204a1b9f4c3a9 (diff) | |
download | genenetwork3-46a96ec0b89620eed4874ada565a9643ac19a042.tar.gz |
README
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 49 |
1 files changed, 31 insertions, 18 deletions
@@ -3,34 +3,27 @@ GeneNetwork3 REST API for data science and machine learning ## Installation -##### Using python-pip +#### Using guix -1. Prepare your system. You need to make you have python > 3.8, and - the ability to install modules. -2. Create and enter your virtualenv: +Simply load up the environment (for development purposes): ```bash -virtualenv --python python3 venv -. venv/bin/activate +guix environment --load=guix.scm ``` -3. Install the required packages + +Also, make sure you have the *guix-bioinformatics* channel set up. ```bash -# The --ignore-installed flag forces packages to -# get installed in the venv even if they existed -# in the global env -pip install -r requirements.txt --ignore-installed +env GUIX_PACKAGE_PATH=~/guix-bioinformatics/ ~/.config/guix/current/bin/guix environment --load=guix.scm +python3 + import redis ``` -#### Using guix +Better run a proper container -Simply load up the environment (for development purposes): - -```bash -guix environment --load=guix.scm ``` - -Also, make sure you have the *guix-bioinformatics* channel set up. +env GUIX_PACKAGE_PATH=~/guix-bioinformatics/ ~/.config/guix/current/bin/guix environment -C --network --load=guix.scm +``` #### Running Tests @@ -62,6 +55,26 @@ To spin up the server: env FLASK_DEBUG=1 FLASK_APP="main.py" flask run --port=8080 ``` +##### Using python-pip + +IMPORTANT NOTE: we do not recommend using pip tools, use Guix instead + +1. Prepare your system. You need to make you have python > 3.8, and + the ability to install modules. +2. Create and enter your virtualenv: + +```bash +virtualenv --python python3 venv +. venv/bin/activate +``` +3. Install the required packages + +```bash +# The --ignore-installed flag forces packages to +# get installed in the venv even if they existed +# in the global env +pip install -r requirements.txt --ignore-installed +``` #### A note on dependencies |