danyoung commited on
Commit
11f992c
1 Parent(s): e0f2fee

Delete README copy.md

Browse files
Files changed (1) hide show
  1. README copy.md +0 -40
README copy.md DELETED
@@ -1,40 +0,0 @@
1
- # MVP Climate Change Demo
2
-
3
- This is a demo of the MVP Climate Change app. It allows users to select a location and year from a map of the world, see its land use composition, and prescribe or manually make changes to it and see the predicted ELUC (Emissions from Land Use Change) and amount of land changed. It is a simple Dash app. The demo can be found online at [landuse.evoluion.ml](https://landuse.evolution.ml)
4
-
5
- ## Downloading the data:
6
-
7
- In ``data/`` there is a script called ``process_data.py``. This will download the entire 2.5GB data file from HuggingFace then process it into a 500MB csv that is used by the app. A token is required to download the data and must be saved in ``$HF_TOKEN``.
8
-
9
- ## Predictors:
10
-
11
- The RandomForest model is 1.7GB and is also saved on HuggingFace. To download it run ``download_predictors.py`` in ``predictors/``. This downloads a ``.joblib`` file that is loaded in the app.
12
-
13
- ## Prescriptors:
14
-
15
- Prescriptors are already stored in `prescriptors/` as well as the pareto front image and a CSV of pareto info from training the prescriptors.
16
-
17
- ## Testing:
18
-
19
- Testing can be done with ``python -m unittest discover``
20
-
21
- To run specific tests run ``python -m unittest tests.test_app TestCase.test_specific_case``
22
-
23
- ## Running the app:
24
-
25
- To run the app call the app module with ``python -m app.app`` or use gunicorn with ``gunicorn -b 0.0.0.0:4057 app.app:server``.
26
-
27
- ## Deployment:
28
-
29
- Once ``process_data.py`` and ``download_predictors.py`` have been run, the app can be deployed by building with:
30
- ```
31
- docker build -t eluc-demo .
32
- ```
33
- then the container can be run with:
34
- ```
35
- docker run \
36
- -v PATH_TO_PROJECT/mvp/use_cases/eluc/demo/data/processed:/usr/local/cognizant/eluc/data/processed:ro \
37
- -v PATH_TO_PROJECT/mvp/use_cases/eluc/demo/predictors:/usr/local/cognizant/eluc/predictors:ro \
38
- -p 8080:4057 eluc-demo
39
- ```
40
- Note: This mounts your local directories to the docker container, different steps may have to be taken for different setups.