Docs examples #45

samgdotson · 2024-02-15T19:42:43Z

This PR adds an initial example notebook for osier and adds more guidance on how to install linear programming solvers on different operating systems.

Edit: This PR actually adds ~~two~~ three example notebooks. One simple example introducing the osier.Technology class, a second example introducing the osier.DispatchModel, and a third demonstrating the osier.CapacityExpansion model.

To reviewers: Please do not request more examples in this PR. Instead, please make an issue describing the example you would like to see! Documentation of this type will never be complete. Thanks.

Edit:

Closes #48 and Closes #49

yardasol

Hi @samgdotson, great PR.

Quick think I noticed was that in certain places in the docs you write Osier and in other places you put osier. I think it is best to be consistent with the capitalization of the software, but maybe you did this intentionally.

Some of the cells in the example notebooks are rendering strangely. See comments below.

setup.py

docs/source/examples/dispatch_tutorial.ipynb

docs/source/examples/index.md

yardasol · 2024-02-21T19:00:49Z

docs/source/examples/tech_tutorial.ipynb

+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }


Suggested change

},

{

"cell_type": "code",

"execution_count": null,

"metadata": {},

"outputs": [],

"source": []

}

}

Get rid of empty cell

Please address this.

docs/source/getting-started/solver_install.md

ZoeRichter

It seems like some of your headings and sub headings are not following consistent capitalization rules. I have recommendations for further things to add, which I will make issues for.

docs/source/examples/dispatch_tutorial.ipynb

docs/source/examples/tech_tutorial.ipynb

docs/source/examples/dispatch_tutorial.ipynb

ZoeRichter · 2024-02-21T19:26:38Z

docs/source/examples/capacity_expansion_tutorial.ipynb

+    "with plt.style.context(\"dark_background\"):\n",
+    "    plt.plot(hours, demand, color='cyan')\n",
+    "    plt.ylabel('Demand [MW]')\n",
+    "    plt.grid(alpha=0.2)\n",


Can you also add x labels?

Please add x and y axis labels to all figures that do not have them. For the graph of demand and wind vs time(?), you can use a double y axis to label them.

docs/source/examples/capacity_expansion_tutorial.ipynb

…-examples

samgdotson · 2024-02-21T22:15:36Z

Thanks for the review @yardasol!

Quick think I noticed was that in certain places in the docs you write Osier and in other places you put osier. I think it is best to be consistent with the capitalization of the software, but maybe you did this intentionally.

I thought I capitalized osier at the beginning of a sentence, only. For the most part I do not capitalize. But I'll look through it again.

samgdotson · 2024-02-21T22:16:50Z

I think I'll convert this PR to a draft PR -- seems like more work needs to be done. @yardasol I am curious about the build system issue with pandoc, though. Can you install it that way? I recall having issues with it...

Co-authored-by: Olek <[email protected]>

samgdotson · 2024-03-02T17:15:26Z

Thanks for the review @smpark7! I added most of your suggestions to the notebooks. I didn't change the order of the capacity expansion notebook -- but I did clarify each of the problems covered in the notebook. Hopefully that's fine for now. As for numbering, I know that's what you do in the moltres docs, but it's not a pattern I committed to here and it seems like mostly a matter of preference.

README.md

setup.py

ZoeRichter

I like the changes to the technology tutorial section, I think you've satisfied the other two learning objectives. I've left some other comments for requested changes, but I don't believe any of it is big enough to create a new issue over.

ZoeRichter · 2024-03-04T18:13:35Z

docs/source/examples/capacity_expansion_tutorial.ipynb

+    "with plt.style.context(\"dark_background\"):\n",
+    "    plt.plot(hours, demand, color='cyan')\n",
+    "    plt.ylabel('Demand [MW]')\n",
+    "    plt.grid(alpha=0.2)\n",


Please add x and y axis labels to all figures that do not have them. For the graph of demand and wind vs time(?), you can use a double y axis to label them.

docs/source/examples/capacity_expansion_tutorial.ipynb

docs/source/examples/dispatch_tutorial.ipynb

smpark7 · 2024-03-04T20:34:27Z

@samgdotson Good work on addressing my comments.

I didn't change the order of the capacity expansion notebook -- but I did clarify each of the problems covered in the notebook. Hopefully that's fine for now.

Yes that is good enough

As for numbering, I know that's what you do in the moltres docs, but it's not a pattern I committed to here and it seems like mostly a matter of preference.

That's fair too.

yardasol

Good improvements, found a few more things to work on.

README.md

yardasol · 2024-03-04T21:11:43Z

docs/source/examples/tech_tutorial.ipynb

+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }


Please address this.

docs/source/examples/dispatch_tutorial.ipynb

docs/source/examples/capacity_expansion_tutorial.ipynb

samgdotson · 2024-03-05T00:14:49Z

Thanks for the reviews @smpark7 @ZoeRichter @yardasol.

I tried to address as much as I could, some things I simply don't agree with. For instance, tone. It makes sense to have a formal tone in the API documentation, but I don't see a reason to enforce formality in a more instructional notebook.

The main request I saw was the addition of labels to all axes and all plots, as well as removing empty cells at the end of the notebooks. Both requests have been fulfilled.

If you're satisfied, please merge whenever.

…ender on github, now.

samgdotson · 2024-03-08T13:51:47Z

Nudge @ZoeRichter @yardasol @smpark7

smpark7 · 2024-03-08T18:30:21Z

Go ahead and merge if yall approve too

samgdotson · 2024-03-12T01:58:32Z

@ZoeRichter @yardasol nudge

samgdotson · 2024-03-18T15:24:39Z

@ZoeRichter @yardasol nudge.

@smpark7 if you're satisfied you can merge.

smpark7 · 2024-03-18T17:40:28Z

Merging is blocked because of the requested changes. You will have to dismiss their reviews first.

Comments addressed, re-review delayed.

samgdotson · 2024-03-18T19:00:31Z

@smpark7 try now?

ZoeRichter · 2024-03-18T19:22:31Z

Now it seems merging is blocked for another reason?

samgdotson · 2024-03-18T19:43:43Z

The was an issue with the ruleset preventing merging. The ruleset has been fixed (readthedocs build is done through read the docs, not GitHub, so I changed the source of the status check. Nothing has been removed).

ZoeRichter · 2024-03-18T19:58:33Z

If there's no other issues that @yardasol wants addressed, I can merge now.

smpark7 · 2024-03-18T20:27:41Z

Given that you addressed their comments and Olek's status indicates that he is currently away, I'm merging this PR.

samgdotson and others added 8 commits May 19, 2023 08:09

adds new install page

8c00cbd

Merge branch 'main' of github.com:samgdotson/osier into docs-examples

85c5750

adds instructions to install lp solvers

f23cc8a

adds more sphinx extensions

39bd170

adds nbsphinx and a first notebook tutorial

cb23d64

adds pandoc

236f98d

adds line in the tech tutorial

ac21b7b

removes problematic build command

dbd8d4f

samgdotson requested review from yardasol and ZoeRichter February 15, 2024 21:21

samgdotson self-assigned this Feb 15, 2024

samgdotson and others added 5 commits February 19, 2024 16:06

updates navigation

18d0f08

adds dispatch model tutorial

82e12ea

updates the dispatch model tutorial

be92b2e

adds capacity expansion notebook

adf4fe8

adds cap expansion tutorial to navigation

3cfeb3a

yardasol requested changes Feb 21, 2024

View reviewed changes

ZoeRichter reviewed Feb 21, 2024

View reviewed changes

samgdotson added 2 commits February 21, 2024 15:59

updates dispatch model tutorial

1b98dfb

Merge branch 'docs-examples' of github.com:samgdotson/osier into docs…

44284cc

…-examples

samgdotson marked this pull request as draft February 21, 2024 22:17

samgdotson and others added 2 commits February 22, 2024 13:42

add pandoc to setup.py

9d7f22a

Co-authored-by: Olek <[email protected]>

changes initial problem to sizing natural gas and a battery

5ba384e

samgdotson requested a review from smpark7 March 2, 2024 17:06

yardasol reviewed Mar 4, 2024

View reviewed changes

README.md Outdated Show resolved Hide resolved

setup.py Show resolved Hide resolved

ZoeRichter previously requested changes Mar 4, 2024

View reviewed changes

smpark7 approved these changes Mar 4, 2024

View reviewed changes

yardasol previously requested changes Mar 4, 2024

View reviewed changes

addresses some review comments from @yardasol and @ZoeRichter

fcbafca

samgdotson requested review from yardasol and ZoeRichter March 4, 2024 23:47

Merge branch 'main' of github.com:arfc/osier into docs-examples

1264e2d

samgdotson added 5 commits March 4, 2024 18:30

fixes note rendering

246f30b

removes extra note statement, it will render on readthedocs but not r…

e2976f6

…ender on github, now.

Merge branch 'main' of github.com:samgdotson/osier into docs-examples

ff2361e

Merge branch 'main' of github.com:samgdotson/osier into docs-examples

00ccb4c

adds .gitattributes

0841bff

smpark7 merged commit 976abcc into arfc:main Mar 18, 2024
2 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Docs examples #45

Docs examples #45

samgdotson commented Feb 15, 2024 •

edited

Loading

yardasol left a comment

yardasol Feb 21, 2024

yardasol Mar 4, 2024

ZoeRichter left a comment

ZoeRichter Feb 21, 2024

ZoeRichter Mar 4, 2024

samgdotson commented Feb 21, 2024

samgdotson commented Feb 21, 2024 •

edited

Loading

samgdotson commented Mar 2, 2024

ZoeRichter left a comment

ZoeRichter Mar 4, 2024

smpark7 commented Mar 4, 2024

yardasol left a comment

yardasol Mar 4, 2024

samgdotson commented Mar 5, 2024

samgdotson commented Mar 8, 2024

smpark7 commented Mar 8, 2024

samgdotson commented Mar 12, 2024

samgdotson commented Mar 18, 2024

smpark7 commented Mar 18, 2024

samgdotson commented Mar 18, 2024

ZoeRichter commented Mar 18, 2024

samgdotson commented Mar 18, 2024

ZoeRichter commented Mar 18, 2024

smpark7 commented Mar 18, 2024

Docs examples #45

Docs examples #45

Conversation

samgdotson commented Feb 15, 2024 • edited Loading

yardasol left a comment

Choose a reason for hiding this comment

yardasol Feb 21, 2024

Choose a reason for hiding this comment

yardasol Mar 4, 2024

Choose a reason for hiding this comment

ZoeRichter left a comment

Choose a reason for hiding this comment

ZoeRichter Feb 21, 2024

Choose a reason for hiding this comment

ZoeRichter Mar 4, 2024

Choose a reason for hiding this comment

samgdotson commented Feb 21, 2024

samgdotson commented Feb 21, 2024 • edited Loading

samgdotson commented Mar 2, 2024

ZoeRichter left a comment

Choose a reason for hiding this comment

ZoeRichter Mar 4, 2024

Choose a reason for hiding this comment

smpark7 commented Mar 4, 2024

yardasol left a comment

Choose a reason for hiding this comment

yardasol Mar 4, 2024

Choose a reason for hiding this comment

samgdotson commented Mar 5, 2024

samgdotson commented Mar 8, 2024

smpark7 commented Mar 8, 2024

samgdotson commented Mar 12, 2024

samgdotson commented Mar 18, 2024

smpark7 commented Mar 18, 2024

samgdotson commented Mar 18, 2024

ZoeRichter commented Mar 18, 2024

samgdotson commented Mar 18, 2024

ZoeRichter commented Mar 18, 2024

smpark7 commented Mar 18, 2024

samgdotson commented Feb 15, 2024 •

edited

Loading

samgdotson commented Feb 21, 2024 •

edited

Loading