Make a python package

.gitignore

@@ -138,5 +138,6 @@ dmypy.json
 cython_debug/
 
 .vscode/
+.idea
 
 *.csv

README.md

@@ -4,10 +4,11 @@
 
 ## Installation
 
-You need to install all dependencies first:
+Install the package from the repository:
 
 ```
-pip install -r requirements.txt
+cd urban-morphology-3d
+pip install .
 ```
 
 Then take your time and install [pymesh](https://pymesh.readthedocs.io/en/latest/installation.html).
@@ -74,7 +75,7 @@ python cityPlot.py [file_path]
 
 1) Download or `git clone` this repository.
 
-2) Install all dependencies: `pip install -r requirements.txt`.
+2) Install the package from the source directory: `pip install .`. To install for development: `pip install -e ".[dev]"`
 
 3) Download a tile from 3D BAG: `wget --header='Accept-Encoding: gzip' https://data.3dbag.nl/cityjson/v210908_fd2cee53/3dbag_v210908_fd2cee53_5910.json`
 

pyproject.toml

@@ -0,0 +1,50 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "3d-building-metrics"
+version = "2024.1006"
+description = "3D Building Metrics"
+readme = "README.md"
+requires-python = ">=3.8"
+license = { text = "MIT" }
+urls = { github = "https://github.com/tudelft3d/3d-building-metrics" }
+dependencies = [
+    "click==8.1.6",
+    "Cython==3.0.0",
+    "geopandas==0.13.2",
+    "ipygany",
+    "jupyter",
+    "mapbox-earcut==1.0.1",
+    "miniball==1.2.0",
+    "numpy==1.24.4",
+    "pandas==2.0.3",
+    "pymesh",
+    "pymeshfix==0.16.2",
+    "python-polylabel",
+    "pyvista==0.36.1",
+    "Rtree==1.0.1",
+    "scikit-learn==1.3.0",
+    "scipy==1.10.1",
+    "shapely==1.8.5",
+    "tqdm==4.65.0",
+]
+optional-dependencies = { dev = ["bumpver", "tox", "pytest", "pytest-cov"] }
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.bumpver]
+current_version = "2024.1006"
+version_pattern = "YYYY.BUILD"
+commit_message = "bump version {old_version} -> {new_version}"
+commit = true
+tag = true
+push = false
+
+[tool.bumpver.file_patterns]
+"pyproject.toml" = [
+    'version = "{version}"',
+]
+

cityCompare.py → src/building_metrics_3d/cityCompare.py

@@ -2,8 +2,8 @@
 import json
 import numpy as np
 from tqdm import tqdm
-import cityjson
-from helpers.mesh import difference, symmetric_difference, to_pymesh, to_pyvista, intersect
+from building_metrics_3d import cityjson
+from building_metrics_3d.helpers.mesh import difference, symmetric_difference, to_pymesh, to_pyvista, intersect
 import pyvista as pv
 import pandas as pd
 import pymesh

cityPlot.py → src/building_metrics_3d/cityPlot.py

@@ -1,7 +1,7 @@
 import click
 import json
 import numpy as np
-from cityjson import to_triangulated_polydata
+from building_metrics_3d.cityjson import to_triangulated_polydata
 import pyvista as pv
 from tqdm import tqdm
 

cityjson.py → src/building_metrics_3d/cityjson.py

@@ -2,7 +2,7 @@
 
 import numpy as np
 from shapely.geometry import Polygon, MultiPolygon
-from helpers.geometry import project_2d, surface_normal, triangulate, triangulate_polygon
+from building_metrics_3d.helpers.geometry import project_2d, surface_normal, triangulate, triangulate_polygon
 import pyvista as pv
 
 def get_surface_boundaries(geom):

geometry.py → src/building_metrics_3d/geometry.py

@@ -2,7 +2,7 @@
 
 import numpy as np
 import pyvista as pv
-from helpers.geometry import plane_params, project_mesh, to_3d
+from building_metrics_3d.helpers.geometry import plane_params, project_mesh, to_3d
 from scipy.spatial import distance_matrix
 from sklearn.cluster import AgglomerativeClustering
 

shape_index.py → src/building_metrics_3d/shape_index.py

@@ -2,9 +2,9 @@
 
 import math
 from shapely.geometry import Point, MultiPoint, Polygon
-from helpers.geometry import surface_normal
+from building_metrics_3d.helpers.geometry import surface_normal
 try:
-    from helpers.mesh import to_pymesh, to_pyvista, intersect
+    from building_metrics_3d.helpers.mesh import to_pymesh, to_pyvista, intersect
     pymesh_exists = True
 except:
     print("WARNING: pymesh not found! Exchange index calculation will be omitted...")

tests/test_shape_index.py

@@ -1,4 +1,4 @@
-import shape_index
+from building_metrics_3d import shape_index
 import pyvista as pv
 from pytest import approx
 from shapely.geometry import Point

tox.ini

@@ -0,0 +1,3 @@
+[tox]
+envlist = py311
+isolated_build = True