fabiogra commited on
Commit
7c6c604
1 Parent(s): cc7efca

docs: update README

Browse files
Files changed (1) hide show
  1. README.md +14 -2
README.md CHANGED
@@ -52,10 +52,14 @@ alt="Buy me a coffee"></a>
52
 
53
  ## Setup
54
  ### Local environment
55
- Create a new environment with Python 3.8 and install the requirements:
56
  ```bash
57
  pip install -r requirements.txt
58
  ```
 
 
 
 
59
  then run the app with:
60
  ```bash
61
  streamlit run app/header.py
@@ -76,7 +80,15 @@ You can set the following environment variables to limit the resources used by t
76
  - ENV_LIMITATION=true
77
  - LIMIT_CPU=true
78
 
79
- If you want to preprocess the samples used in the demo, you need to set the env variable `PREPARE_SAMPLES=true`
 
 
 
 
 
 
 
 
80
 
81
  ---
82
  ## About
 
52
 
53
  ## Setup
54
  ### Local environment
55
+ Create a new environment with Python 3.10 and install the requirements:
56
  ```bash
57
  pip install -r requirements.txt
58
  ```
59
+ set the `PYTHONPATH` to the root folder:
60
+ ```bash
61
+ export PYTHONPATH=path/to/moseca
62
+ ```
63
  then run the app with:
64
  ```bash
65
  streamlit run app/header.py
 
80
  - ENV_LIMITATION=true
81
  - LIMIT_CPU=true
82
 
83
+ ### (Optional) Preprocess samples
84
+ If you want to preprocess the samples used in the demo, you need to set the env variable `PREPARE_SAMPLES=true` as a secret (create the file `run/secrets/PREPARE_SAMPLES` with `true` value inside).
85
+
86
+ If you run locally you also need to move the files inside `scripts` to the root folder and run `prepare_samples.sh`.
87
+ ```
88
+ cp scripts/ .
89
+ chmod +x prepare_samples.sh
90
+ python prepare_samples.sh
91
+ ```
92
 
93
  ---
94
  ## About