doc: add more prominent disclaimer to README.md about development status

[daniel-rdt]

Changes proposed in this Pull Request

This PR proposes a more prominent wip disclaimer to the project Readme file and improves the limitations and development status section of the readme and documentation.

Disclaimer

Improved development status section

Open todos before merging:

• Update the projects limitations description to include reference to dev status and tyndp methodology
• Add warning to readthedocs index.rst as well
• Update dev status

Checklist

• I tested my contribution locally and it works as intended.
• Code and workflow changes are sufficiently documented.
• Changed dependencies are added to envs/environment.yaml.
• Changes in configuration options are added in config/config.default.yaml.
• Changes in configuration options are documented in doc/configtables/*.csv.
• OET license identifier is added to all edited or newly created code files.
• Sources of newly added data are documented in doc/data_sources.rst.
• A release note doc/release_notes.rst is added.

[tgilon]

I also suggest linking to the development status. Currently, the Limitations section refers to PyPSA-Eur limitations. Our current dev status adds up other limitations to reproduce the TYNDP 2024 specifically.

[daniel-rdt]

I also suggest linking to the development status. Currently, the Limitations section refers to PyPSA-Eur limitations. Our current dev status adds up other limitations to reproduce the TYNDP 2024 specifically.

I was considering adding the current Open-TYNDP limitations based on the development status to that Limitations page. On the other hand it could make sense to differentiate this into:

• Limitations: General limitations of the TYNDP and limitations of PyPSA-Eur
• Development status: Current development status which should include clearly the limitations in terms of incomplete features

What do you think? @tgilon

[daniel-rdt]

@tgilon As discussed earlier, I introduced some minor improvements to the limitations section and the development status section of the readme and the documentation. I decided to include a full feature table in the Features in development subsection that also includes completed features as I thought that it looks nicer to see the progress

[tgilon]

Thanks! This looks great to me. I've made minor suggestions / comments. I suggest adding an item to the PR template to help keep this updated.

Could you also update the screenshot in the description to improve the doc of the PR? Tks

[tgilon]

LGTM