search

OpenEnergyPlatform / oeplatform

Repository for the code of the Open Energy Platform (OEP) website. The OEP provides an interface to the Open Energy Family
http://openenergyplatform.org/
GNU Affero General Public License v3.0
62 stars 19 forks source link

Create document for guidance #405

Closed han-f closed 2 years ago

han-f commented 5 years ago

Create one document that describes the whole process of how to contribute scenario data to the OpenEnergy Platform from the perspective of a new user.

christian-rli commented 4 years ago

Will it be a pdf? If it's not decided yet: it could just be another jupyter tutorial for which a template exists. Maybe it helps.

han-f commented 4 years ago

We have created a PDF file some time ago that underwent suggestion by IEE. The current version is on the filr. v.0.2 under AP5.5.-Integration-Daten. So if nothing has really changed since then, we could use this document and link to it in the tutorial section. @christian-rli , what do you think? This also describes the whole process from registering, over uploading, to triggering the review process (as it is now). So for complete beginners this could be a good guidance without being too technical.

wingechr commented 4 years ago

Chapter 1 and 2 of the document are still valid, but chapter 3 (factsheets) needs rework after the chanegs on the platform has been implemented. Currently, his is a little broken.

han-f commented 4 years ago

We have updated the document further based on @Richard-Schmitz comments - many thanks for these. Apart from chapter 3 this should be thus ready for being added to the tutorials section. @christian-rli - could you please advise what to do? Could you also have a look at chapter 3 (its short) and see whether it is ok to upload it? Many thanks.

christian-rli commented 3 years ago

I had a look at chapter 3 and it looks good to me @han-f . As we discussed in our call the pdf is based on a word file that can easily be converted to mark-up. It can be copied into the tutorial creator on the OEP once the image upload works (again). So, unfortunately there is no easy publish button for pdfs and there will have to be some manual attention. Hopefully it's not too much of a bother.

han-f commented 3 years ago

We have added this to tutorials now, but still need to work a bit on formatting issues (e.g. python code displays correctly in preview, but not in final view).

https://openenergy-platform.org/tutorials/11/

christian-rli commented 2 years ago

Formatting should be a separate issue. The topic of this one has been addressed in my opinion :)