Skip to content

Env instructions#70

Merged
nsryan2 merged 14 commits into
arfc:mainfrom
samgdotson:env-instructions
Oct 8, 2024
Merged

Env instructions#70
nsryan2 merged 14 commits into
arfc:mainfrom
samgdotson:env-instructions

Conversation

@samgdotson

@samgdotson samgdotson commented Oct 4, 2024

Copy link
Copy Markdown
Collaborator

This PR

  • closes No env control in installation instructions #58 by adding an environment.yml file and instructions to install it the environment in the README and
  • closes Example accessibility #57 by adding a Binder badge that links to the example notebooks. There are ways to have the examples in the top-level directory (example), such as with the nbsphinx-link package, but I could not get it to work properly.

Lastly, this PR addresses the request from @fredshone to have a notebook that emphasizes the multi-objective aspects of osier by creating a new notebook called getting-started which serves as a "minimum working example."

@samgdotson samgdotson added Comp:Build This issue has to do with the build system of the code/doc (makefiles, cmake, install errors) Difficulty:1-Beginner This issue does not require expert knowledge and may be a good issue for new contributors. Priority:1-Critical This is the highest priority (i.e. it is blocking other work or facing a deadline). Status:5-In Review This issue has been handled, and the solution is being reviewed. (probably as a PR) Type:Docs Is related to API documentation, website content, etc. labels Oct 4, 2024
@samgdotson samgdotson added this to the JOSS publication -- Osier milestone Oct 4, 2024
@samgdotson samgdotson requested a review from yardasol October 4, 2024 02:01
@samgdotson samgdotson self-assigned this Oct 4, 2024
@samgdotson samgdotson requested a review from nsryan2 October 7, 2024 14:03
nsryan2 added a commit that referenced this pull request Oct 7, 2024
@nsryan2
Merge pull request #69 from samgdotson/0.3.1
a14b673 
Ok, I see you've added this change in #70, merging to defer changes to that PR.
nsryan2
nsryan2 approved these changes Oct 7, 2024
View reviewed changes

@nsryan2 nsryan2 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM! Some minor comments about consistency in the notebooks, but the bulk of these files are simple changes that look good.

Comment thread docs/source/examples/capacity_expansion_tutorial.ipynb
Comment thread docs/source/examples/getting_started.ipynb
@samgdotson

samgdotson commented Oct 7, 2024

Copy link
Copy Markdown
Collaborator Author

@nsryan2 thanks for the review. I updated the tick_labels in the box plots. I also added a Binder badge to every notebook.

If you're happy, please merge!

@samgdotson samgdotson mentioned this pull request Oct 8, 2024
Closed
@nsryan2 nsryan2 merged commit 7e5f71b into arfc:main Oct 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nsryan2 nsryan2 nsryan2 approved these changes

@yardasol yardasol Awaiting requested review from yardasol

Assignees

@samgdotson samgdotson

Labels

Comp:Build This issue has to do with the build system of the code/doc (makefiles, cmake, install errors) Difficulty:1-Beginner This issue does not require expert knowledge and may be a good issue for new contributors. Priority:1-Critical This is the highest priority (i.e. it is blocking other work or facing a deadline). Status:5-In Review This issue has been handled, and the solution is being reviewed. (probably as a PR) Type:Docs Is related to API documentation, website content, etc.

Projects

None yet

Milestone

JOSS publication -- Osier

Development

Successfully merging this pull request may close these issues.

No env control in installation instructions Example accessibility

2 participants

@samgdotson @nsryan2