Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation with the cleaned history #603

Merged
merged 11 commits into from
Mar 16, 2023

Conversation

ekatef
Copy link
Member

@ekatef ekatef commented Feb 13, 2023

That is an improved version of #602 built on a cleaned fork of main (@davide-f thanks a lot for providing proper spells for it!)

This update is intended to improve clarity and usability of our documentation and is mainly based on inputs from @yerbol-akhmetov and @davide-f. (Yerbol and Davide, thanks a lot for an insightful discussion!)

The suggested fixes contain:

  • revision on natura.tiff usage to account for the recent developments;
  • clarifications on cutout usage;
  • improvement of explanations on data clean-up.

Checklist

  • I tested my contribution locally and it seems to work fine.
  • Code and workflow changes are sufficiently documented.
  • Newly introduced dependencies are added to envs/environment.yaml and envs/environment.docs.yaml.
  • Changes in configuration options are added in all of config.default.yaml and config.tutorial.yaml.
  • Add a test config or line additions to test/ (note tests are changing the config.tutorial.yaml)
  • Changes in configuration options are also documented in doc/configtables/*.csv and line references are adjusted in doc/configuration.rst and doc/tutorial.rst.
  • A note for the release notes doc/release_notes.rst is amended in the format of previous release notes, including reference to the requested PR.

(cherry picked from commit 455f556)
@ekatef ekatef mentioned this pull request Feb 13, 2023
7 tasks
(cherry picked from commit e1a9265)
Add recommendations on temporal extent of the cutout

Add headers

Fix typos

Clarify the description

Remove an outdated note

Fix grammar

Fix typo

(cherry picked from commit 79bab6aaf81da3b759888388235163d245708a22)
Copy link
Member

@davide-f davide-f left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to me :) I'd merge if you have finished here

@ekatef
Copy link
Member Author

ekatef commented Feb 18, 2023

Thanks @davide-f!

If you don't mind I'd be happy to add a couple points about time settings as discussed in #609 which seem to be well aligned the current content. However, if you feel like it'd be better to create another PR for that, I'm absolutely fine with it :)

@davide-f
Copy link
Member

Ok! Then I'll wait ;)

@davide-f
Copy link
Member

davide-f commented Feb 28, 2023

@ekatef given #612, can this PR be merged or shall we wait?

@ekatef
Copy link
Member Author

ekatef commented Feb 28, 2023

@davide-f not yet :) In #612 @asv365 is addressing fine structure of doc/configuration.rst (previously some sections were captured from the wrong fragments).

Here we need a couple of additions to clarify which snapshot values are appropriate when customising the model. Sorry for the delay, will try to add these explanations today

@ekatef
Copy link
Member Author

ekatef commented Mar 1, 2023

@davide-f added the promised points. If you approve these additions, I think this PR can be merged

@pz-max
Copy link
Member

pz-max commented Mar 9, 2023

Let's talk at today's weekly about this PR. Looks good to me @ekatef

@davide-f davide-f merged commit 679dd4d into pypsa-meets-earth:main Mar 16, 2023
@ekatef ekatef deleted the fix_docs_clean branch November 14, 2023 22:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants