topotherm icon indicating copy to clipboard operation
topotherm copied to clipboard

Improve documentation on io module

Open ddceruti opened this issue 1 year ago • 3 comments

Including detailed explanation of dims, units.

ddceruti avatar Oct 28 '24 08:10 ddceruti

Add clear description of parquet files reading, because indexes are not included (so when converting csv to parquet extreme care for indices is required)

ddceruti avatar Oct 28 '24 13:10 ddceruti

Hello, Is there perhaps an explanation somewhere on how to create input incidence matrices in parquet format? Or am I just not finding this in the docs? Many thanks in advance.

benblankenstein avatar Sep 03 '25 07:09 benblankenstein

@benblankenstein The documentation is currently a work in progress and will be a main focus of upcoming releases. In the meantime, you can already find a function to create the necessary matrices under ./topotherm/create_matrices in the repository.

This function takes three shapefiles as input:

  • Street layout (street.shp)
  • Heat sinks (heat_sinks.shp)
  • Heat sources (heat_sources.shp)

The centroids of the heat sinks are automatically connected by the shortest distance to the road network, and the required Parquet files for the optimization model are generated. The function is well-commented, but it is not yet included in the documentation.

If you have any questions about how to use it, please don’t hesitate to reach out.

jylambert avatar Sep 03 '25 18:09 jylambert