Skip to content

Commit

Permalink
ENH: Add UserWarning with 'Getting started' link (#638)
Browse files Browse the repository at this point in the history
  • Loading branch information
tnatt authored Apr 29, 2024
1 parent bd59010 commit 73001ef
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions src/fmu/dataio/dataio.py
Original file line number Diff line number Diff line change
Expand Up @@ -490,6 +490,14 @@ def __post_init__(self) -> None:
if self._config_is_valid:
# TODO: This needs refinement: _config_is_valid should be removed
self.config = global_configuration.roundtrip(self.config)
else:
warnings.warn(
"The global config file is lacking key information, hence no metadata "
"will be exported. Follow the simple 'Getting started' steps "
"to do necessary preparations and enable metadata export: "
"https://fmu-dataio.readthedocs.io/en/latest/preparations.html ",
UserWarning,
)

self._classification = self._get_classification()
self._rep_include = self._get_rep_include()
Expand Down

0 comments on commit 73001ef

Please sign in to comment.