Skip to content

Commit

Permalink
expand docs
Browse files Browse the repository at this point in the history
  • Loading branch information
martinfleis authored Feb 14, 2024
1 parent 0d3db77 commit f61fb85
Showing 1 changed file with 16 additions and 3 deletions.
19 changes: 16 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,20 @@ Either clone and pip install or pip install from git.

See the notebooks in the `docs` folder.

## Generate data for a new area using the Demoland pipeline
## How to get Demoland app for a new area?

Top level overview:

1. Generate the required files using the Demoland pipeline Docker container
2. Commit engine-related files to `demoland-engine` repository
3. Commit app-related files to `demoland-web` repository

The rest should be automatic.

### Generate data for a new area using the Demoland pipeline

> [!IMPORTANT]
> The pipeline requires a decent amount of RAM (about 12GB at peak but we've seen even 22GB when running on Apple Silicon under emulation) and a fast internet connect (it needs to download 1.3GB of OSM data). Depending on the size of the area and a machine it can take anywhere from 15 minutes to a few hours.
The process of generating data for a new area is provided in the form of a Docker container.
You will need to provide four pieces of information:
Expand Down Expand Up @@ -43,9 +56,9 @@ docker run \
The container generates two ZIP files. One shall be used in `demoland_engine`, and the
other shall be used to deploy the app.

The file `engine.zip` contains files to be added to the `data` folder of the `demoland-engine` repository. Use the information in `hashes.json` to update `data.py` in the `demoland_engine` code.
The file `engine.zip` contains files to be added to the `data` folder of the `demoland-engine` repository. Use the information in `hashes.json` to update `data.py` in the `demoland_engine` code. The result should look like the [PR #7](https://github.com/Urban-Analytics-Technology-Platform/demoland-engine/pull/7).

The file `app.zip` contains all the necessary files to generate the webapp. Note that the new version of `demoland_engine` with all the files from `engine.zip` and correct hashes needs to be deployed before the app. See the [dedicated documenation on the app deployment](https://github.com/Urban-Analytics-Technology-Platform/demoland-web/blob/main/CUSTOM_AREA.md).
The file `app.zip` contains all the necessary files to generate the webapp. Note that the new version of `demoland_engine` with all the files from `engine.zip` and correct hashes needs to be deployed before the app. See the [dedicated documenation on the app deployment](https://github.com/Urban-Analytics-Technology-Platform/demoland-web/blob/main/CUSTOM_AREA.md). There's no need to pay a lot of attention to the contents of each file as all of them are autogenerated by the pipeline.

### Building the container

Expand Down

0 comments on commit f61fb85

Please sign in to comment.