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

Documentation Update #189

Merged
merged 6 commits into from
Aug 16, 2023
Merged

Documentation Update #189

merged 6 commits into from
Aug 16, 2023

Conversation

trevorb1
Copy link
Member

@trevorb1 trevorb1 commented Aug 15, 2023

Description

This PR implements documentation updates following the feedback received from the JOSS reviewers.

To-Do List

  • Proof-read
  • Update validation docs
  • Solver installation for Windows
  • Solver installation via conda
  • Fix typo of "Parmaters Foramt" on data page

Notable changes

  • Added simple data.txt file for validation example
  • Moved solver installation to the start of the examples section

Copy link
Member

@willu47 willu47 left a comment

Choose a reason for hiding this comment

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

Hi @trevorb1 - I spotted a few typos, otherwise good to go. And thanks for writing up the tutorial for the validation functionality!

docs/examples.rst Outdated Show resolved Hide resolved
docs/examples.rst Outdated Show resolved Hide resolved
docs/examples.rst Outdated Show resolved Hide resolved
@trevorb1 trevorb1 merged commit 8a46113 into OSeMOSYS:master Aug 16, 2023
3 of 4 checks passed
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.

2 participants