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

Features/add esys docs #198

Merged
merged 7 commits into from
Nov 2, 2023
Merged

Features/add esys docs #198

merged 7 commits into from
Nov 2, 2023

Conversation

MaGering
Copy link
Collaborator

@MaGering MaGering commented Nov 2, 2023

Fixes #113

Before merging into dev-branch, please make sure that the following points are checked:

  • All pre-commit tests passed locally with: pre-commit run -a
  • File CHANGELOG.md was updated
  • The docs were updated
    • [ ] if dataset.mds were updated, the dataset docs were regenerated using
      python docs/generate_dataset_mds.py

If packages were modified:

  • [ ] File poetry.lock was updated with: poetry lock
  • [ ] A new env was successfully set up

WARNING: When modifying use snakemake <=7.32.0, cf. #186

If data flow was adjusted:

  • [ ] Data pipeline run finished successfully with: snakemake -jX

  • [ ] Esys appdata was created successfully with: snakemake -jX make_esys_appdata

    (with X = desired number of cores, e.g. 1)

@MaGering MaGering added the documentation 📝 Improvements or additions to documentation label Nov 2, 2023
@MaGering MaGering self-assigned this Nov 2, 2023
docs/sections/esys.md Outdated Show resolved Hide resolved
@MaGering MaGering requested a review from nesnoj November 2, 2023 10:25
@MaGering
Copy link
Collaborator Author

MaGering commented Nov 2, 2023

First draft of esys documentation is ready for review. Let me know what you think @nesnoj

docs/sections/esys.md Outdated Show resolved Hide resolved
docs/sections/esys.md Outdated Show resolved Hide resolved
docs/sections/esys.md Outdated Show resolved Hide resolved
@nesnoj
Copy link
Member

nesnoj commented Nov 2, 2023

First draft of esys documentation is ready for review. Let me know what you think @nesnoj

Thanks a lot for this docs part! 🙏
I'll check ...

@nesnoj nesnoj merged commit c82186b into dev Nov 2, 2023
@nesnoj nesnoj deleted the features/add_esys_docs branch November 2, 2023 14:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation 📝 Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document energy system model
2 participants