https://github.com/vcityteam/py3dtilers
Tilers accepting various input formats (OBJ, 3DCity databases, GeoJson, IFC) and producing 3DTiles tilesets.
https://github.com/vcityteam/py3dtilers
3d-tiles 3dcitydb 3dtiles b3dm citygml geojson ifc obj open-source opensource python
Last synced: 10 days ago
JSON representation
Tilers accepting various input formats (OBJ, 3DCity databases, GeoJson, IFC) and producing 3DTiles tilesets.
- Host: GitHub
- URL: https://github.com/vcityteam/py3dtilers
- Owner: VCityTeam
- License: lgpl-2.1
- Created: 2021-06-01T16:19:37.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2025-03-28T12:50:30.000Z (24 days ago)
- Last Synced: 2025-04-03T10:08:35.825Z (19 days ago)
- Topics: 3d-tiles, 3dcitydb, 3dtiles, b3dm, citygml, geojson, ifc, obj, open-source, opensource, python
- Language: Python
- Homepage:
- Size: 65.1 MB
- Stars: 221
- Watchers: 14
- Forks: 59
- Open Issues: 55
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Py3DTilers: an open-source toolkit to create 3DTiles
## :warning: Arrested development :warning:
Alas, starting on January 2025, the current Py3dTilers development team will move on to new projects. Py3dTilers will thus no longer be developed nor maintained.
The **current repository owners are thus looking for a community** (a set of individuals, teams or corporations) that would be willing to adopt py3dTilers in order to pursue the development activity.
This transition could take the form of adding new developers and transmitting the MAINTAINER role (at the repository level).
But, as allowed by the [LICENSE](https://github.com/VCityTeam/py3dtilers/blob/master/LICENSE.md), the transmission could go as far as relinquishing the repository ownership to another responsible organization.
At this stage, some contacts were made with some public or private organizations (currently using and/or contributing to py3dTilers). If the future of py3dTilers interests you, and you would willing to engage some resources to take the lead on
maintaining/developing py3dTilers, please provide [in this issue](https://github.com/VCityTeam/py3dtilers/issues/196) some sketchy declaration of intention and possibly a coarse roadmap.
Deciding the actual form of transmission will be based on the result of the public discussion happening [in this issue](https://github.com/VCityTeam/py3dtilers/issues/196).
---
[](https://app.travis-ci.com/VCityTeam/py3dtilers)
[](https://vcityteam.github.io/py3dtilers/py3dtilers/index.html)
[](https://www.python.org/downloads/release/python-3918/) [](https://www.python.org/downloads/release/python-31013/) [](https://www.python.org/downloads/release/python-3116/) [](https://www.python.org/downloads/release/python-3124/)
Py3DTilers is a Python tool and library allowing to build [`3D Tiles`](https://github.com/CesiumGS/3d-tiles) tilesets out of various geometrical formats e.g. [OBJ](https://en.wikipedia.org/wiki/Wavefront_.obj_file), [GeoJSON](https://en.wikipedia.org/wiki/GeoJSON), [IFC](https://en.wikipedia.org/wiki/Industry_Foundation_Classes) or [CityGML](https://en.wikipedia.org/wiki/CityGML) through [3DCityDB databases](https://3dcitydb-docs.readthedocs.io/en/release-v4.2.3/).
Py3DTilers uses [`Py3DTiles` python library](https://gitlab.com/py3dtiles/py3dtiles) for its in memory representation of tilesets.
Py3DTilers can only produce [`Batched 3D Models (B3DM)`](https://github.com/CesiumGS/3d-tiles/blob/main/specification/TileFormats/Batched3DModel/README.md). If you want to produce [`Point Clouds (PNTS)`](https://github.com/CesiumGS/3d-tiles/blob/main/specification/TileFormats/PointCloud/README.md), see [Py3DTiles CLI](https://gitlab.com/py3dtiles/py3dtiles/-/blob/master/docs/cli.rst).
An article that presents the tool is available in the ISPRS annals [here](https://hal.science/hal-03852828/).
## Demo
Find 3D Tiles created with Py3DTilers in [**this online demo**](https://projet.liris.cnrs.fr/vcity/permalink/demo-py3dtilers.html).
## CLI Features
- [Common features](./py3dtilers/Common#common-module): features shared by all tilers
- [ObjTiler](./py3dtilers/ObjTiler#obj-tiler): converts OBJ files to a 3D Tiles tileset
- [GeojsonTiler](./py3dtilers/GeojsonTiler#geojson-tiler): converts GeoJson files to a 3D Tiles tileset
- [IfcTiler](./py3dtilers/IfcTiler#ifc-tiler): converts IFC files to a 3D Tiles tileset
- [CityTiler](./py3dtilers/CityTiler#city-tiler): converts CityGML features (e.g buildings, water bodies, terrain...) extracted from a 3dCityDB database to a 3D Tiles tileset
- [TilesetReader](./py3dtilers/TilesetReader#tileset-reader): read, merge or transform 3DTiles tilesets
## Installation from sources
See [supported Python versions](#py3dtilers-an-open-source-toolkit-to-create-3dtiles)
### For Unix
Install binary sub-dependencies with your platform package installer e.g. for Ubuntu use
```bash
apt-get install -y libpq-dev # required usage of psycopg2 within py3dtilers
apt-get install python3 python3-dev
```
Install Py3DTilers in a safe [python virtual environment](https://docs.python.org/3/tutorial/venv.html) (not mandatory yet quite recommended)
```bash
apt-get install virtualenv git
git clone https://github.com/VCityTeam/py3dtilers
cd py3dtilers
virtualenv -p python3 venv
. venv/bin/activate
(venv)$ pip install -e .
```
### For Windows
In order to install Py3DTilers from sources use:
```bash
git clone https://github.com/VCityTeam/py3dtilers
cd py3dtilers
python3 -m venv venv
. venv/Scripts/activate
(venv)$ pip install -e .
```
## Usage
In order to access to the different flavors of tilers, refer to the corresponding readmes to discover their respective usage and features:
- Common features [readme](py3dtilers/Common/README.md)
- CityTiler [readme](py3dtilers/CityTiler/README.md)
- GeojsonTiler [readme](py3dtilers/GeojsonTiler/README.md)
- ObjTiler [readme](py3dtilers/ObjTiler/README.md)
- IfcTiler [readme](py3dtilers/IfcTiler/README.md)
- TilesetReader [readme](py3dtilers/TilesetReader/README.md)
Useful tutorials:
- [CityTiler usage example](./docs/Doc/cityGML_to_3DTiles_example.md)
- [GeojsonTiler usage example](./docs/Doc/geoJSON_to_3DTiles_example.md)
- [Visualize 3DTiles in Cesium, iTowns or UD-Viz](https://github.com/VCityTeam/UD-SV/blob/master/ImplementationKnowHow/Visualize3DTiles.md)
- [Create 3DTiles from OpenStreetMap data](https://github.com/VCityTeam/UD-SV/blob/master/ImplementationKnowHow/OSM_to_3DTiles.md)
- [Host CityGML data in 3DCityDB](https://github.com/VCityTeam/UD-SV/blob/master/ImplementationKnowHow/PostgreSQL_for_cityGML.md)
## Develop with Py3DTilers
Before commiting, please [run tests](#running-the-tests) and make sure [coding style](#coding-style) is respected.
### Running the tests
After the installation, if you additionally wish to run unit tests, use
```bash
(venv)$ pip install -e .[dev,prod]
(venv)$ pytest
```
To run CityTiler's tests, you need to install PostgreSQL and Postgis.
To setup PostgreSQL with Postgis on Windows, follow the first step (1. Download PostgreSQL/PostGIS) of [3DCityDB tutorial](https://github.com/VCityTeam/UD-SV/blob/master/ImplementationKnowHow/PostgreSQL_for_cityGML.md#1-download-postgresqlpostgis).
For Ubuntu, follow [this tutorial](https://github.com/VCityTeam/UD-SV/blob/master/Install/Setup_PostgreSQL_PostGIS_Ubuntu.md).
### Coding style
First, install the additional dev requirements
```bash
(venv)$ pip install -e .[dev]
```
To check if the code follows the coding style, run `flake8`
```bash
(venv)$ flake8 .
```
You can fix most of the coding style errors with `autopep8`
```bash
(venv)$ autopep8 --in-place --recursive py3dtilers/
```
If you want to apply `autopep8` from root directory, exclude the _venv_ directory
```bash
(venv)$ autopep8 --in-place --exclude='venv*' --recursive .
```
### Developing Py3DTilers together with py3dtiles
By default, the Py3DTilers' [`setup.py`](https://github.com/VCityTeam/py3dtilers/blob/master/setup.py#L30) build stage uses [github's version of py3dtiles](https://github.com/VCityTeam/py3dtiles) (as opposed to using [Oslandia's version on Pypi](https://pypi.org/project/py3dtiles/).
When developing one might need/wish to use a local version of py3dtiles (located on host in another directory e.g. by cloning the original repository) it is possible
1. to first install py3dtiles by following the [installation notes](https://github.com/Oslandia/py3dtiles/blob/master/docs/install.rst)
2. then within the Py3DTilers (cloned) directory, comment out (or delete) [the line reference to py3dtiles](https://github.com/VCityTeam/py3dtilers/blob/master/setup.py#L30).
This boils down to :
```bash
$ git clone https://github.com/VCityTeam/py3dtiles
$ cd py3dtiles
$ ...
$ source venv/bin/activate
(venv)$ cd ..
(venv)$ git clone https://github.com/VCityTeam/py3dtilers
(venv)$ cd py3dtilers
(venv)$ # Edit setup.py and comment out py3dtiles reference
(venv)$ pip install -e .
(venv)$ pytest
```
### Concerning CityTiler
- For developers, some [design notes](docs/Doc/CityTilerDesignNotes.md)
- Credentials: CityTiler original code is due to Jeremy Gaillard (when working at LIRIS, University of Lyon, France)
### Configuring your IDE
When configuring your IDE to run a specific tiler, you must indicate the module you want to run (e.g. py3dtilers.CityTiler.CityTiler) and not the path to the file (i.e. not ${workspace_root}/py3dtilers/CityTiler/CityTiler.py), otherwise python will not be able to resolve the relative import of the Tilers to the Common package of Py3DTilers. An example of launch configuration in VSCode:
```json
{
"version": "0.2.0",
"configurations": [
{
"name": "", // e.g. "CityTiler" or "bozo"
"type": "python",
"request": "launch",
"module": "", // e.g. py3dtilers.CityTiler.CityTiler
"args": [
"--db_config_path",
"${workspaceRoot}/py3dtilers/CityTiler/"
],
"console": "integratedTerminal"
}
]
}
```
### Profiling
Python standard module [cProfile](https://docs.python.org/3/library/profile.html) allows to profile Python code.
#### **In code**
Import modules:
```python
import cProfile
import pstats
```
Profile the code between `enable()` and `disable()`:
```python
cp = cProfile.Profile()
cp.enable() # Start profiling
# code here
cp.disable() # Stop profiling
p = pstats.Stats(cp)
p.sort_stats('tottime').print_stats() # Sort stats by time and print them
```
#### **In command line**
cProfile can be run in the shell with:
```bash
python -m cProfile script.py
```