Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vcityteam/ud-demo-vcity-sunlight

Demos of porting 3DUSE Sunlight to UD-Viz
https://github.com/vcityteam/ud-demo-vcity-sunlight

3d-tiles sunlight vcity visualization

Last synced: about 1 month ago
JSON representation

Demos of porting 3DUSE Sunlight to UD-Viz

Awesome Lists containing this project

README

        

# UD-Demo-VCity-Sunlight

- [UD-Demo-VCity-Sunlight](#ud-demo-vcity-sunlight)
- [About The Project](#about-the-project)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Deployment](#deployment)
- [Contributing](#contributing)
- [License](#license)
- [Main Contributors](#main-contributors)
- [Acknowledgments](#acknowledgments)

## About The Project

Vizualisation of 3DTiles produces by [pySunlight containing](https://github.com/VCityTeam/pySunlight) light pre-calculation results.

In this demo, we show two vizualisation of Sunlight :

- Sunlight and Shadow vizualisation
- Impact

It's based on [UD-Viz-Template](https://github.com/VCityTeam/UD-Viz-Template).

UD-Demo-VCity-Sunlight is one repository of the Sunlight project, including :

- [Sunlight](https://github.com/VCityTeam/Sunlight)
- [pySunlight](https://github.com/VCityTeam/pySunlight)
- [pySunlight-docker](https://github.com/VCityTeam/pySunlight-docker)
- [UD-Demo-VCity-Sunlight](https://github.com/VCityTeam/UD-Demo-VCity-Sunlight)

## Getting Started

### Prerequisites

Install npm, refer to [here](https://github.com/VCityTeam/UD-SV/blob/master/Tools/ToolNpm.md).

### Installation

1. Download the git repository :

```bash
git clone https://github.com/VCityTeam/UD-Demo-VCity-Sunlight.git && cd UD-Demo-VCity-Sunlight
```

2. Install npm dependencies :

```bash
npm i --legacy-peer-deps && npm i
```

3. Builds and runs the app in the development mode.

```bash
npm run debug
```

4. Open [http://localhost:8000/](http://localhost:8000/) to view it in your browser.

When changes are made to the files, the app is automatically rebuilt (no need to execute the run debug command again).

### Usage

Use [UD-Viz developers documention](https://github.com/VCityTeam/UD-Viz/blob/master/docs/static/Developers.md#npm-scripts) to see the full list of npm supported commands.

Refer to [this](docs/data-processing/README.md#data-processing) documentation to create and display 3D Tiles Sunlight.

### Deployment

1. Build docker image :

```bash
docker build -t demo-sunlight . --no-cache
```

2. Run the container :

```bash
docker run -p 0.0.0.0:8080:8000/tcp --rm -t demo-sunlight
```

3. Go to [http://localhost:8080/](http://localhost:8080/) to see Demo-Sunlight.

## Contributing

Follow the guidelines of [UD-Viz developpers](https://github.com/VCityTeam/UD-Viz/blob/master/docs/static/Developers.md#developers).

## License

Distributed under the LGPL-2.1 License. See `LICENSE` and `Libraries Licenses` for more information.

## Main Contributors

- Wesley Petit - [Website](https://wesleypetit.fr/) -

## Acknowledgments

- [UD-Viz](https://github.com/VCityTeam/UD-Viz)
- [pySunlight](https://github.com/VCityTeam/pySunlight)