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

Addressing a handful of open github issues #741

Merged
merged 14 commits into from
Jun 25, 2024
Merged
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/new_release_checklist.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Release
about: Checklist!
---

Since the dev branch only includes materials that have been peer-reviewed at least once this PR review process should be relatively smooth should. That being said, before merging this branch into main and the new release is created several things must be completed first.

* Open a PR into main branch, it should be titled with the new release number
* Let Leeyabot generate a report detailing how the Hector output has changed!
* Add text to the PR documenting the major model changes. The PR is going to serve as an important record
* Update the outputstreams via command line & commit them as part of the PR
* Pass automated checks
* Change the version number in the DESCRIPTION file
* Update the NEWS.md, are links additional materials necessary? Does the release need a new naming file?
* Check to make sure the internal package data is up to date (fxntable, inputstable, unitstable)

After merging PR

* Create the release via zenodo
* Add the zenodo links to README / NEWS & push directly to main
* Create new dev branch & update the DESCRIPTION version number to support the pkgdown documentation for the developmental branch!

2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ libs/
*.suo

# Output
output/*.csv
output/tracking*.csv
Copy link
Member

Choose a reason for hiding this comment

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

The problem with this as way to address #734 is that running an unmodified model will produce modified (from git's point of view) files, because of the timestamp at the top of the outputs...which I don't think is the behavior we want. It seems better to create an example_outputs/ directory, perhaps as a subdirectory of output/.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hmmm that is a good point, do we want to add that or does it make sense to include the output streams as part of the release materials?

Copy link
Member

Choose a reason for hiding this comment

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

Either works, but I like your suggestion.


# R
.Rhistory
Expand Down
3 changes: 2 additions & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,8 @@ hector_tas_results$scenario <- ifelse(hector_tas_results$year <= 2016, "historic
ggplot(hector_tas_results) +
geom_line(aes(year, value, color = scenario), linewidth = 1) +
theme_bw(base_size = 15) +
labs(color = NULL, x = NULL, y = expression("Temperature Anomaly ("~degree~"C)")) +
theme(axis.title = element_text(size=12))+
Copy link
Member

Choose a reason for hiding this comment

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

Super picky, but please size = 12

labs(color = NULL, x = NULL, y = expression("Temperature Anomaly Relative to 1750 ("~degree~"C)")) +
scale_color_manual(values = SSP_COLORS)
```

Expand Down
2 changes: 1 addition & 1 deletion inst/include/component_data.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@
// methane component
#define D_CH4_CONC "CH4" CONCENTRATION_EXTENSION
#define D_PREINDUSTRIAL_CH4 "M0"
#define D_RF_CH4 "FCH4"
#define D_RF_CH4 D_RF_PREFIX "CH4"
#define D_EMISSIONS_CH4 "CH4_emissions"
#define D_CONSTRAINT_CH4 "CH4_constrain"
#define D_NATURAL_CH4 "CH4N"
Expand Down
Binary file modified man/figures/README-tas_plot-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 7 additions & 1 deletion output/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
This directory is the location where Hector outputs will be written when running Hector via command line, Xcode, ect. Running Hector through the R interface will __not__ produce any csv outputs here.

Included are example outputs from Hector driven with ssp245.
TODO update outputstreams before new releases.

```
sh test_hector.sh src/hector
```



Loading
Loading