aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 0a24153d0164f0cbdf5079c97386f4cc697931ac (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
# genenetwork3
GeneNetwork3 REST API for data science and machine  learning

## Installation

##### Using python-pip

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
pip install -r requirements.txt
```

#### Using guix

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.

#### Running Tests

(assuming you are in a guix container; otherwise use venv!)

To run tests:

```bash
python -m unittest discover -v
```

Running pylint:

```bash
pylint *py tests gn3
```

Running mypy(type-checker):

```bash
mypy .
```

#### Running the flask app

To spin up the server:

```bash
env FLASK_DEBUG=1 FLASK_APP="main.py" flask run --port=8080
```