Skip to content

Commit

Permalink
Improving docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Paolo authored and Paolo committed Apr 30, 2024
1 parent a52aac6 commit 49c9c8b
Show file tree
Hide file tree
Showing 4 changed files with 1,504 additions and 1,502 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,22 +4,25 @@
Repository for the BostonTwin dataset API.

## Requirements
The basic requirements for the BostonTwin API are based on those of [Sionna]<https://nvlabs.github.io/sionna/>, plus some georeferencing libraries:
The basic requirements for the BostonTwin API are based on those of [Sionna](<https://nvlabs.github.io/sionna/>), plus some georeferencing libraries:
1. `python>=3.8`
2. `geopandas`
3. `open3d`
4. `contextily`

and the corresponding dependencies.

We provide a requirement file for pip (`requirements.txt`) and conda (`environment.yaml`) to create a Python virtual environment with all the dependencies.
Additionally, we provide a DOCKERFILE to generate a container with all the required libraries. This is the preferred method.

## Quickstart
1. Clone this repo
2. Install the requirements. We suggest using the provided DOCKERFILE.
3. Download the BostonTwin dataset from <http://hdl.handle.net/2047/D20623157> into the `bostontwin` folder.
2. Download the BostonTwin dataset from <http://hdl.handle.net/2047/D20623157> into the `bostontwin` folder.
3. Install the requirements. We suggest using the provided DOCKERFILE:
a. From the boston_twin directory, run `docker build -t bostontwin -f DOCKERFILE .`
b. Run the container binding the boston_twin directory to the container: `docker run --privileged=true --gpus=all --mount type=bind,src=".",target="/home/root/boston_twin" --env NVIDIA_DRIVER_CAPABILITIES=graphics,compute,utility --rm -it boston_twin`
4. Run the [bostontwin_demo](<https://github.com/wineslab/boston_twin/blob/main/bostontwin_demo.ipynb>) Jupyter Notebook to see how to use BostonTwin, the Digital Twin of Boston!
5. Refer to the [documentation](<>) for additional information.
5. Refer to the [documentation](<https://wineslab.github.io/boston_twin/src/classes/BostonTwin.html>) for additional information.

## Workflow

Expand Down
2 changes: 1 addition & 1 deletion docs/search.js

Large diffs are not rendered by default.

Loading

0 comments on commit 49c9c8b

Please sign in to comment.