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

Remove radiative_energy_toa #1154

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Remove radiative_energy_toa #1154

wants to merge 1 commit into from

Conversation

Sbozzolo
Copy link
Member

@Sbozzolo Sbozzolo commented Jan 29, 2025

radiative_energy_toa is a field fully owned by atmos. There is no reason for ClimaCoupler to maintain a copy. Instead, we can directly access the value from atmos if we need it (it's only needed for conservation checks).

Summary by CodeRabbit

  • Refactor
    • Removed an obsolete measurement field for top-of-atmosphere radiative flux from simulation configurations, simplifying energy conservation checks and data handling.
  • Tests
    • Adjusted test setups to align with the streamlined field management, ensuring consistent validation of simulation behavior.

@Sbozzolo Sbozzolo marked this pull request as draft January 29, 2025 00:49
Copy link

coderabbitai bot commented Apr 7, 2025

Walkthrough

The changes remove all references to the :radiative_energy_flux_toa field across various parts of the simulation code. Several experiment scripts no longer add this field to their coupler field arrays, and conditional logic in the simulation setup has been modified accordingly. Additionally, functions that previously accepted or processed this field in source modules have been updated to remove it, and test cases have been adjusted to reflect the new initialization procedures.

Changes

File(s) Change Summary
experiments/ClimaEarth/run_*.jl
(run_cloudless_aquaplanet.jl, run_cloudy_aquaplanet.jl, run_cloudy_slabplanet.jl, run_dry_held_suarez.jl, run_moist_held_suarez.jl)
Removed :radiative_energy_flux_toa from the coupler_field_names array.
experiments/ClimaEarth/setup_run.jl Modified the CoupledSimulation function by removing the conditional addition of :radiative_energy_flux_toa, now adding only :P_net when energy_check is true.
experiments/ClimaEarth/test/debug_plots_tests.jl Removed :radiative_energy_flux_toa from the coupler_names array.
src/ConservationChecker.jl Streamlined the assignment of radiative_energy_flux_toa by directly obtaining its value via Interfacer.get_field.
src/Interfacer.jl Removed Val{:radiative_energy_flux_toa} from the valid field options in the get_field function for AtmosModelSimulation.
test/conservation_checker_tests.jl Revised the initialization of radiative_energy_flux_toa by replacing the prior field-based assignment with a direct multiplication expression.

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e46514f and 44e1e57.

📒 Files selected for processing (10)
  • experiments/ClimaEarth/run_cloudless_aquaplanet.jl (0 hunks)
  • experiments/ClimaEarth/run_cloudy_aquaplanet.jl (0 hunks)
  • experiments/ClimaEarth/run_cloudy_slabplanet.jl (0 hunks)
  • experiments/ClimaEarth/run_dry_held_suarez.jl (0 hunks)
  • experiments/ClimaEarth/run_moist_held_suarez.jl (0 hunks)
  • experiments/ClimaEarth/setup_run.jl (1 hunks)
  • experiments/ClimaEarth/test/debug_plots_tests.jl (0 hunks)
  • src/ConservationChecker.jl (1 hunks)
  • src/Interfacer.jl (0 hunks)
  • test/conservation_checker_tests.jl (1 hunks)
💤 Files with no reviewable changes (7)
  • experiments/ClimaEarth/test/debug_plots_tests.jl
  • experiments/ClimaEarth/run_cloudy_aquaplanet.jl
  • experiments/ClimaEarth/run_cloudy_slabplanet.jl
  • experiments/ClimaEarth/run_cloudless_aquaplanet.jl
  • experiments/ClimaEarth/run_dry_held_suarez.jl
  • src/Interfacer.jl
  • experiments/ClimaEarth/run_moist_held_suarez.jl
🚧 Files skipped from review as they are similar to previous changes (3)
  • src/ConservationChecker.jl
  • experiments/ClimaEarth/setup_run.jl
  • test/conservation_checker_tests.jl
⏰ Context from checks skipped due to timeout of 90000ms (9)
  • GitHub Check: ci 1.11 - windows-latest
  • GitHub Check: ci 1.11 - macOS-latest
  • GitHub Check: ci 1.11 - ubuntu-latest
  • GitHub Check: ci 1.10 - windows-latest
  • GitHub Check: ci 1.10 - macOS-latest
  • GitHub Check: ci 1.10 - ubuntu-latest
  • GitHub Check: test (1.11)
  • GitHub Check: docbuild
  • GitHub Check: test (1.10)

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@Sbozzolo Sbozzolo marked this pull request as ready for review April 7, 2025 21:47
@Sbozzolo Sbozzolo requested a review from juliasloan25 April 7, 2025 21:47
@Sbozzolo Sbozzolo force-pushed the gb/retoa branch 2 times, most recently from 4ffb9e2 to dca9af1 Compare April 7, 2025 21:52
Copy link
Member

@juliasloan25 juliasloan25 left a comment

Choose a reason for hiding this comment

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

thank you!

`radiative_energy_toa` is a field fully owned by atmos. There is no
reason for ClimaCoupler to maintain a copy. Instead, we can directly
access the value from atmos if we need it (it's only needed for
conservation checks).
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.

2 participants