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

Refine export_rms_volumetrics to export_volumetrics #795

Open
2 of 8 tasks
mferrera opened this issue Sep 23, 2024 · 0 comments
Open
2 of 8 tasks

Refine export_rms_volumetrics to export_volumetrics #795

mferrera opened this issue Sep 23, 2024 · 0 comments
Assignees

Comments

@mferrera
Copy link
Collaborator

mferrera commented Sep 23, 2024

Because this function is imported from fmu.dataio.export.rms the additional rms in the function name is duplicated.

def export_rms_volumetrics(
project: Any,
grid_name: str,
volume_job_name: str,
global_config: str | Path | dict = "../../fmuconfig/output/global_variables.yml",
forcefolder: str = "", # unsure if we shall allow this?
subfolder: str = "",
name: str = "",
tagname: str = "",
classification: str = "restricted",
workflow: str = "rms volumetric run",
) -> dict[str, str]:

We should also re-order the keyword arguments so that the last ones are

     global_config: str | Path | dict = "../../fmuconfig/output/global_variables.yml",
     classification: str | None = None, # Actual default from config
     workflow: str = "rms volumetric run",

We also decided not to expose tagname to users through any of the simplified functions.

Tasks

  • Alias export_rms_volumetrics as export_volumetrics
  • Update documentation and example with this change
  • Remove tagname as a keyword argument
    • Tagname should be a defaulted scheme internally that, if changed, must be done the "hard way" through ExportData
  •  Remove name
  • Remove subfolder
  • Sink the aforementioned keyword arguments to the bottom of the argument list, and in the order listed here
  • Change the default classification to be None and ensure the actual default is the default value in the global config
  • Should providing a dict for the global config be supported still?
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

No branches or pull requests

2 participants