Expand README files - Githubissues

IEC-61400-15 / eya_def

This repository provides a digital format for exchange of information on wind plant energy yield assessment reporting as defined by IEC 61400-15-2.

BSD 3-Clause "New" or "Revised" License

10 stars 0 forks source link

Expand README files #39

Closed jonssonchristian closed 9 months ago

jonssonchristian commented 9 months ago

This PR addresses #29.

It includes the following additions and changes:

Add more background and context to the repo README file;
Divide the Python package README file into user guidance and developer guidance, to make it clearer what content is relevant for what group;
Reorganise the two README files and make editorial changes; and
Add an I/O module with a parser and a writer module to the Python package, and include an example using the parser in the Python package README file.

jonssonchristian commented 9 months ago

@AlinaBurmesterRWE, this PR is for the expansion of the README files that we discussed back in December. I finally got to it now.

Do you think you would have time to review?

Rather than looking at the changes, it might be easier just to read the new versions of both README files (the general one for the EYA DEF and the one for the Python package) and see if you have any comments.

jonssonchristian commented 9 months ago

Great, thank you @AlinaBurmesterRWE.