Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ipadjen authored Jan 13, 2024
1 parent e698762 commit 02eec43
Showing 1 changed file with 2 additions and 5 deletions.
7 changes: 2 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

![welcome_figure](https://github.com/tudelft3d/City4CFD/blob/main/docs/images/workflow.png)

City4CFD--*City for CFD*--is a cross-platform tool that aims to automatically reconstruct 3D city geometries tailored for microscale urban flow simulations.
City4CFD--*City for CFD*--is a tool that aims to automatically reconstruct 3D city geometries tailored for microscale urban flow simulations.

It can create automatically a terrain from a point cloud and imprint different surfaces (e.g. green areas, water, roads).

Expand All @@ -34,7 +34,7 @@ City4CFD is developed by the [3D Geoinformation Research Group](https://3d.bk.tu
**Output** is in the following formats: OBJ, STL, and CityJSON. The ID of each polygon is preserved, and there is a 1-to-1 mapping between the input and the output.

## Installation
You can directly compile City4CFD on your system using cmake, run it through a Docker container, install using Homebrew in the case of macOS, or use a precompiled binary on Windows.
You can directly compile City4CFD on your system using cmake, run it through a Docker container, or install using Homebrew in the case of macOS.

### Build from source
The following libraries are required to build the project:
Expand Down Expand Up @@ -77,9 +77,6 @@ Mac users can install City4CFD through Homebrew:
brew install tudelft3d/software/city4cfd
```

### Windows
Windows users can use a precompiled binary in [Releases](https://github.com/tudelft3d/City4CFD/releases).

## Getting started

The folder *examples* contains example datasets you can run for your first reconstruction. You can run your first reconstruction from the `/examples/TUD_Campus` folder by typing:
Expand Down

0 comments on commit 02eec43

Please sign in to comment.