Rename ertbox -> grid_geometry #12202

oyvindeide · 2025-10-31T14:04:12Z

Issue
Resolves #my_issue

Approach
Short description of the approach

(Screenshot of new behavior in GUI if applicable)

PR title captures the intent of the changes, and is fitting for release notes.
Added appropriate release note label
Commit history is consistent and clean, in line with the contribution guidelines.
Make sure unit tests pass locally after every commit (git rebase -i main --exec 'just rapid-tests')

When applicable

When there are user facing changes: Updated documentation
New behavior or changes to existing untested code: Ensured that unit tests are added (See Ground Rules).
Large PR: Prepare changes in small commits for more convenient review
Bug fix: Add regression test for the bug
Bug fix: Add backport label to latest release (format: 'backport release-branch-name')

codecov-commenter · 2025-10-31T14:13:38Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 90.54%. Comparing base (b894195) to head (8fe82d0).
⚠️ Report is 19 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #12202      +/-   ##
==========================================
- Coverage   90.58%   90.54%   -0.04%     
==========================================
  Files         435      436       +1     
  Lines       29933    30007      +74     
==========================================
+ Hits        27114    27171      +57     
- Misses       2819     2836      +17

Flag	Coverage Δ
cli-tests	`37.37% <27.27%> (+0.02%)`	⬆️
gui-tests	`68.55% <30.30%> (-0.13%)`	⬇️
performance-and-unit-tests	`73.94% <93.93%> (+<0.01%)`	⬆️
test	`38.07% <9.09%> (-0.04%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

xjules · 2025-10-31T14:23:35Z

src/ert/storage/migration/to16.py

+    new_configs = {}
+    for param_config in parameters_json.values():
+        if param_config["type"] == "field":
+            param_config["grid_dimensions"] = param_config.pop("ertbox_params")


I guess this should be param_config.pop("ertbox_params", None)?

xjules

Just had a small comment in the migration but otherwise good.

codspeed-hq · 2025-10-31T14:28:30Z

CodSpeed Performance Report

Merging this PR will not alter performance

_{Comparing oyvindeide:rename_ertbox (8fe82d0) with main (8c03d9e)}

Summary

✅ 22 untouched benchmarks

oddvarlia · 2025-12-03T19:46:49Z

A comment: I am not sure renaming ertbox to grid_dimensions is a good approach since this contains more than grid dimensions. The class ErtboxParameters contains not only grid dimensions, but equally important a definition of a local coordinate system used for calculating the transformation of observations positions into the local grid coordinate system.

oddvarlia

I am not sure we should rename this to grid_dimensions since the class ErtboxParameters not only contains grid dimensions (nx,ny,nz) but equally important a definition of the local coordinate system for the field parameters. grid_dimensions is not a very descriptive name of the class ErtboxParameters

oyvindeide · 2026-01-09T13:03:47Z

I am not sure we should rename this to grid_dimensions since the class ErtboxParameters not only contains grid dimensions (nx,ny,nz) but equally important a definition of the local coordinate system for the field parameters. grid_dimensions is not a very descriptive name of the class ErtboxParameters

Good point, renamed it: GridGeometry instead 👍

xjules · 2026-01-09T13:14:01Z

src/ert/config/field.py

    type: Literal["field"] = "field"
    dimensionality: Literal[3] = 3
-    ertbox_params: ErtboxParameters
+    grid_geometry: GridGeometry


I like grid_geometry!

GridGeometry is better. but what about all documentation. ERTBOX has been used for a long time in courses and documentation including APS and its documentation. I don't think I will change it in APS repo, at least not now, but APS and ERT does not share code. But fmutools and APS share code and ERTBOX is consistenty used there also. The repo subscript also uses the ERTBOX as name for the field parameter grids.

But maybe we can still use ERTBOX as terminology, but use GridGeometry as the name of the ERT python class. My argument for this is that GridGeometry is very general, but ERTBOX is for field parameter grid to be used as field parameters in ERT.

xjules · 2026-01-09T13:31:05Z

tests/ert/unit_tests/config/test_field.py

+def field_with_grid_params():
    # Return a Field object for test purpose
-    # Define parameters for the grid (ertbox parameters)
+    # Define parameters for the grid (grid parameters)


# Define parameters for the grid (its geometry)

xjules

Good renaming!
Optional: write a simple unit test test_to22.py

xjules reviewed Oct 31, 2025

View reviewed changes

xjules approved these changes Oct 31, 2025

View reviewed changes

oddvarlia self-requested a review December 3, 2025 19:49

oddvarlia requested changes Dec 3, 2025

View reviewed changes

oddvarlia requested a review from xjules December 3, 2025 19:53

oyvindeide force-pushed the rename_ertbox branch 3 times, most recently from b125179 to b497559 Compare January 8, 2026 07:18

Rename ertbox -> grid_geometry

8fe82d0

oyvindeide force-pushed the rename_ertbox branch from b497559 to 8fe82d0 Compare January 8, 2026 11:30

oyvindeide changed the title ~~Rename ertbox -> grid dimensions~~ Rename ertbox -> gri_geometry Jan 9, 2026

oyvindeide changed the title ~~Rename ertbox -> gri_geometry~~ Rename ertbox -> grid_geometry Jan 9, 2026

oyvindeide added the release-notes:skip If there should be no mention of this in release notes label Jan 9, 2026

xjules reviewed Jan 9, 2026

View reviewed changes

xjules approved these changes Jan 9, 2026

View reviewed changes

Rename ertbox -> grid_geometry #12202

Are you sure you want to change the base?

Rename ertbox -> grid_geometry #12202

Uh oh!

Conversation

oyvindeide commented Oct 31, 2025

When applicable

Uh oh!

codecov-commenter commented Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

xjules Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

xjules left a comment

Choose a reason for hiding this comment

Uh oh!

codspeed-hq bot commented Oct 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging this PR will not alter performance

Summary

Uh oh!

oddvarlia commented Dec 3, 2025

Uh oh!

oddvarlia left a comment

Choose a reason for hiding this comment

Uh oh!

oyvindeide commented Jan 9, 2026

Uh oh!

xjules Jan 9, 2026

Choose a reason for hiding this comment

Uh oh!

oddvarlia Jan 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

oddvarlia Jan 16, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

xjules Jan 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

xjules left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

codecov-commenter commented Oct 31, 2025 •

edited

Loading

codspeed-hq bot commented Oct 31, 2025 •

edited

Loading

oddvarlia Jan 16, 2026 •

edited

Loading

oddvarlia Jan 16, 2026 •

edited

Loading

xjules Jan 9, 2026 •

edited

Loading