Skip to content

Commit ce68ef1

Browse files
authored
DOC: Add experimental flag to Nested Hybrid Grid module (#441)
Since Nested Hybrid Grid is still experimental and the API will change as we experiment on it, we need to flag it so that user understand the risk. No test as it's only documentation and temporarily printing out a warning.
1 parent 3328410 commit ce68ef1

2 files changed

Lines changed: 12 additions & 0 deletions

File tree

docs/nestedhybridgrid.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,12 @@
11
Nested Hybrid Grids
22
====================
33

4+
.. admonition:: 🧪 Experimental Feature
5+
:class: warning
6+
7+
This module is currently experimental. It may undergo breaking changes
8+
in future versions without notice.
9+
410
.. contents:: Table of Contents
511
:local:
612
:depth: 2

src/fmu/tools/nestedhybridgrid/nestedhybrid.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717
from __future__ import annotations
1818

1919
import logging
20+
import warnings
2021
from typing import TYPE_CHECKING
2122

2223
import numpy as np
@@ -358,6 +359,11 @@ def create_nested_hybrid_grid(
358359
the coarse grid and *nnc_table* is a :class:`pandas.DataFrame` mapping
359360
mother cells to their connected refined cells.
360361
"""
362+
warnings.warn(
363+
"create_nested_hybrid_grid is currently experimental. It may undergo "
364+
"breaking changes in future versions without notice.",
365+
FutureWarning,
366+
)
361367
if any(r < 1 for r in refinement):
362368
raise ValueError(f"Refinement factors must be >= 1, got {refinement}")
363369

0 commit comments

Comments
 (0)