Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ozekik/cityview

CityJSON loader and renderer for three.js, react-three-fiber, and Jupyter Notebook / JupyterLab
https://github.com/ozekik/cityview

citygml cityjson jupyter jupyter-notebook jupyterlab python threejs

Last synced: 3 months ago
JSON representation

CityJSON loader and renderer for three.js, react-three-fiber, and Jupyter Notebook / JupyterLab

Host: GitHub
URL: https://github.com/ozekik/cityview
Owner: ozekik
License: mit
Created: 2024-08-14T20:32:39.000Z (5 months ago)
Default Branch: master
Last Pushed: 2024-09-11T17:01:35.000Z (4 months ago)
Last Synced: 2024-09-28T23:41:56.579Z (3 months ago)
Topics: citygml, cityjson, jupyter, jupyter-notebook, jupyterlab, python, threejs
Language: TypeScript
Homepage:
Size: 2.57 MB
Stars: 3
Watchers: 1
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

README

        # CityView

[![PyPI](https://img.shields.io/pypi/v/cityview.svg)](https://pypi.org/project/cityview/)

[![npm](https://img.shields.io/npm/v/three-cityjson)](https://www.npmjs.com/package/three-cityjson)

CityJSON loader and renderer for [Three.js](https://threejs.org/), [React-three-fiber](https://github.com/pmndrs/react-three-fiber), and [Jupyter Notebook / JupyterLab](https://jupyter.org/).

Supports [CityJSON format](https://www.cityjson.org/) and [CityJSONSeq format](https://www.cityjson.org/cityjsonseq/).

## Contents

- [Packages](#packages)

- [Installation](#installation)

- [Usage](#usage)

- [Roadmap](#roadmap)

- [License](#license)

## Packages

|  Package Name  | Description | Registry |

|----------------|-------------|------------|

| [cityview](https://github.com/ozekik/cityview) (top-level package) | Python package | [![PyPI](https://img.shields.io/pypi/v/cityview.svg)](https://pypi.org/project/cityview/) |

| [three-cityjson](https://github.com/ozekik/cityview/tree/master/packages/three-cityjson) | JavaScript / TypeScript package | [![npm](https://img.shields.io/npm/v/three-cityjson)](https://www.npmjs.com/package/three-cityjson) |

## Installation

```bash

pip install cityview

```

## Usage

### Basic usage

#### VirtualView

```python

import cityview as cv

view = cv.VirtualView(theme="light")

with open("./packages/three-cityjson/public/sample/daiba_sta.city.jsonl", "r") as f:

    data = f.read()

view.layers = [

    cv.CityJSONLayer(data=data, format="cityjsonseq")

]

view.update()

view

```

![VirtualView](./assets/virtualview-light-sshot_01.png)

#### MapView

```python

import cityview as cv

view = cv.MapView(theme="dark")

with open("./packages/three-cityjson/public/sample/daiba_sta.city.jsonl", "r") as f:

    data = f.read()

view.layers = [

    cv.CityJSONLayer(data=data, format="cityjsonseq")

]

view.update()

view

```

![VirtualView](./assets/mapview-dark-sshot_01.png)

### Handling click events

```python

import cityview as cv

view = cv.VirtualView(theme="light")

with open("./packages/three-cityjson/public/sample/daiba_sta.city.jsonl", "r") as f:

    data = f.read()

def handler(change):

    print(change["new"])

view.observe(handler, names="click")

view.layers = [

    cv.CityJSONLayer(data=data, format="cityjsonseq")

]

view.update()

view

```

## Roadmap

- [ ] Online viewer

## License

MIT