Integrate CityJson read - Githubissues

samuelduchesne / pyumi

open and edit UMI projects with Python

4 stars 4 forks source link

Integrate CityJson read #8

Open samuelduchesne opened 3 years ago

samuelduchesne commented 3 years ago

Hi @jszczesniak and @zberzolla

There is a placeholder for you to fill in the logic to read CityJSON. For it work with the current workflow, the method needs to:

[ ] Process the file
[ ] Extract footprints as ˋshapely.geometry.Polygons`. I believe you’ll need to create the geometries from a list of points. Example here.
[ ] Extract the metadata for each building
[ ] Create a GeoDataFrame from said footprints and metadata. Some examples here.
[ ] Pass the GeoDataFrame to the cls.from_gdf constructor.

The method placeholder is here: https://github.com/samuelduchesne/pyumi/blob/dc195428934517360c969bf596ab573353211c38/pyumi/umi_project.py#L494-L529

[ ] Create a test that will be called by the continuous integration process. This test needs to assert Some value that you know is true in order to pass.

samuelduchesne commented 3 years ago

I recommend using Pycharm to help you navigate the code, refactor portions of code and automate the formatting.

As shown the README.md, this package uses black and I sort (and flake8) to maintain a consistent code format.

Within pycharm, one can define external programs and call isort black and flake8 with keyboard shortcuts. If not, these can be invoked manually in the terminal:

At the root of the repository, run in this order:

isort: isort . (mind the period)
black: black . (mind the period)
flake8: python -m flake8 pyumi/