Skip to content

Updates to improve input demo documentation - #4035

Open
abbylewis wants to merge 13 commits into
PecanProject:developfrom
abbylewis:peprmt_vis
Open

Updates to improve input demo documentation#4035
abbylewis wants to merge 13 commits into
PecanProject:developfrom
abbylewis:peprmt_vis

Conversation

@abbylewis

Copy link
Copy Markdown
Collaborator

Description

Updated the PEPRMT demos, including:

  • More text explanation, especially in the first two demos
  • Added year as a PEcAn standard variable (was listed as a TODO)
  • New visualizations in the second demo so users see that it's working
    @infotroph not huge updates, but I think this should be helpful for CARB/etc to understand what's happening in the demos

Review Time Estimate

  • Immediately
  • Within one week
  • When possible

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My change requires a change to the documentation.
  • My name is in the list of CITATION.cff
  • I agree that PEcAn Project may distribute my contribution under any or all of
    • the same license as the existing code,
    • and/or the BSD 3-clause license.
  • I have updated the CHANGELOG.md.
  • I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

Comment thread models/peprmt/demo_run/01_run_pecan_peprmt.qmd Outdated
Comment thread models/peprmt/demo_run/01_run_pecan_peprmt.qmd

@infotroph infotroph 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.

Thanks! I agree this is a big improvement. I left a few suggestions throughout, mostly with wording suggestions you can modify or reject freely.

Comment on lines 4 to 5
- "Aritra Dey"
- "David LeBauer"

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.

At this point you've modified the source demo enough that it's probably appropriate to list yourself as the sole author and credit previous work with wording something like "This demo is patterned after PEcAn demo 1 (link here), which was written by Aritra Dey and David LeBauer". @AritraDey-Dev and @dlebauer does that make sense to y'all?

Comment thread models/peprmt/demo_run/01_run_pecan_peprmt.qmd Outdated
Comment thread models/peprmt/demo_run/01_run_pecan_peprmt.qmd Outdated
Comment thread models/peprmt/demo_run/01_run_pecan_peprmt.qmd
Comment thread models/peprmt/demo_run/01_run_pecan_peprmt.qmd
Comment thread models/peprmt/demo_run/02_input_demo.qmd Outdated
Comment thread models/peprmt/demo_run/02_input_demo.qmd Outdated
Comment thread models/peprmt/demo_run/02_input_demo.qmd
select("site_id", "run_id", "posix", "CH4_flux") |>
ggplot() +
aes(x = posix,
y = CH4_flux * 1E6 * 60 * 60 * 24, # Convert from kg/m2/s to mg/m2/d

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.

Same suggestion to use ud_convert here as above

Comment thread models/peprmt/demo_run/03_event_demo.qmd Outdated
abbylewis and others added 6 commits July 30, 2026 18:12
Co-authored-by: Chris Black <chris@ckblack.org>
Co-authored-by: Chris Black <chris@ckblack.org>
Co-authored-by: Chris Black <chris@ckblack.org>
Co-authored-by: Chris Black <chris@ckblack.org>
Co-authored-by: Chris Black <chris@ckblack.org>
Co-authored-by: Chris Black <chris@ckblack.org>
Comment thread base/utils/data/standard_vars.csv Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants