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

Add TimeManager module #9

Merged
merged 1 commit into from
Sep 26, 2023
Merged

Add TimeManager module #9

merged 1 commit into from
Sep 26, 2023

Conversation

juliasloan25
Copy link
Member

@juliasloan25 juliasloan25 commented Sep 13, 2023

Purpose

Closes #6

Interface changes from other repos

ClimaCoupler.jl

  • current_date function removed, should be added to ClimaCoupler.jl Utilities module
  • trigger_callback interface has changed, now increments cutoff date internally (so the result must get saved wherever the function is called from), and takes in callback function to be called if condition is met
    Use ClimaUtilities.jl CallbackManager module ClimaCoupler.jl#423

ClimaLSM.jl

  • no changes :)

  • I have read and checked the items on the review checklist.

Copy link
Member

@kmdeck kmdeck left a comment

Choose a reason for hiding this comment

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

looks good! minor comments for clarification

src/TimeManager.jl Outdated Show resolved Hide resolved
src/TimeManager.jl Show resolved Hide resolved
test/timemanager.jl Outdated Show resolved Hide resolved
Copy link

@LenkaNovak LenkaNovak left a comment

Choose a reason for hiding this comment

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

LGTM, thanks, Julia! Just a few comments.

# TimeManager

This module contains functions that handle dates and times
in simulations. The functions in this module often call

Choose a reason for hiding this comment

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

"coupled simulations" may be more accurate?

Copy link
Member Author

Choose a reason for hiding this comment

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

Some of these functions (e.g. to_datetime) are used in the bucket model in ClimaLSM, which can be run standalone or in a coupled simulation, so I think it makes sense to keep the comment more general

src/TimeManager.jl Outdated Show resolved Hide resolved
@juliasloan25
Copy link
Member Author

@szy21 @glwagner

docs/src/timemanager.md Outdated Show resolved Hide resolved
@juliasloan25 juliasloan25 force-pushed the js/timemanager branch 2 times, most recently from 8294a5c to 8574bbb Compare September 20, 2023 21:16
@juliasloan25
Copy link
Member Author

This branch has been tested within ClimaCoupler and works there, so I'm merging it into main

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.

TimeManager module
4 participants