Incomplete tutorial oem2orm and wrong repository

OpenEnergyPlatform / data-preprocessing

Repository for data formatting, import of data, data and metadata review, and data curation.

GNU Affero General Public License v3.0

10 stars 7 forks source link

Incomplete tutorial oem2orm and wrong repository #53

Closed christian-rli closed 4 years ago

christian-rli commented 4 years ago

The tutorial in this repository on the branch feature/oep-upload-oem2orm is incomplete. Fix the following:

[x] Inform users that red output is fine in that one command
[x] Fix error when first executing oem2orm.create_tables(db, ordered_orm)
[ ] Include sample gpkg-file to make it completely self reliant
[x] Make sure it runs all the way through, including the tests that data are on the DB
[x] Move it to the examples/tutorials repository

jh-RLI commented 4 years ago

@christian-rli Since there is already a tutorial for Upload data, this would be redundant. For the user, it is surely useful to go through the whole process. But maybe it is reasonable to refer to the next tutorial.

jh-RLI commented 4 years ago

Fix error when first executing oem2orm.create_tables(db, ordered_orm): https://github.com/OpenEnergyPlatform/oedialect/issues/34

christian-rli commented 4 years ago

@christian-rli Since there is already a tutorial for Upload data, this would be redundant. For the user, it is surely useful to go through the whole process. But maybe it is reasonable to refer to the next tutorial.

@jh-RLI There is no tutorial that leads through the entire process in the recommended manner. It's true that there is another upload tutorial, but oem2orm will need to be merged into that or the other way around. There needs to be one complete best practice upload manual.

I think starting from the beginning (oem2orm to create the tables) will be the easiest way to build it. Do feel free to copy parts of the other tutorials, we can clean up redundancies later.

christian-rli commented 4 years ago

@jh-RLI you checked a couple of boxes. Did you start working on a new branch for that or did you forget to push your changes?

jh-RLI commented 4 years ago

@christian-rli I have linked the branch as PR. Currently this is the branch where I developed the tool and the tutorials. I can move the tutorials to the tutorials repo. soon.

christian-rli commented 4 years ago

@christian-rli I have linked the branch as PR. Currently this is the branch where I developed the tool and the tutorials. I can move the tutorials to the tutorials repo. soon.

ok. thanks for clearing this up

jh-RLI commented 4 years ago

The oem2orm tool got its own repository. All development is moved there.