resqpy.derived_model.add_one_grid_property_array

resqpy.derived_model.add_one_grid_property_array(epc_file, a, property_kind, grid_uuid=None, source_info='imported', title=None, discrete=False, uom=None, time_index=None, time_series_uuid=None, string_lookup_uuid=None, null_value=None, indexable_element='cells', facet_type=None, facet=None, realization=None, local_property_kind_uuid=None, count_per_element=1, const_value=None, expand_const_arrays=False, points=False, extra_metadata={}, use_int32=True, new_epc_file=None)

Adds a grid property from a numpy array to an existing resqml dataset.

Parameters:

  • epc_file (string) – file name to load resqml model from (and rewrite to if new_epc_file is None)

  • a (3D numpy array) – the property array to be added to the model; for a constant array set this None and use the const_value argument, otherwise this array is required

  • property_kind (string) – the resqml property kind

  • grid_uuid (uuid object or string, optional) – the uuid of the grid to which the property relates; if None, the property is attached to the ‘main’ grid

  • source_info (string) – typically the name of a file from which the array has been read but can be any information regarding the source of the data

  • title (string) – this will be used as the citation title when a part is generated for the array; for simulation models it is desirable to use the simulation keyword when appropriate

  • discrete (boolean, default False) – if True, the array should contain integer (or boolean) data; if False, float

  • uom (string, default None) – the resqml units of measure for the data; not relevant to discrete data

  • time_index (integer, default None) – if not None, the time index to be used when creating a part for the array

  • time_series_uuid (uuid object or string, default None) – required if time_index is not None

  • string_lookup_uuid (uuid object or string, optional) – required if the array is to be stored as a categorical property; set to None for non-categorical discrete data; only relevant if discrete is True

  • null_value (int, default None) – if present, this is used in the metadata to indicate that this value is to be interpreted as a null value wherever it appears in the data (use for discrete data only)

  • indexable_element (string, default 'cells') – the indexable element in the supporting representation (the grid)

  • facet_type (string) – resqml facet type, or None

  • facet (string) – resqml facet, or None

  • realization (int) – realization number, or None

  • local_property_kind_uuid (uuid.UUID or string) – uuid of local property kind, or None

  • count_per_element (int, default 1) – the number of values per indexable element; if greater than one then this must be the fastest cycling axis in the cached array, ie last index

  • const_value (float or int, optional) – if present, a constant array is added ‘filled’ with this value, in which case argument a should be None

  • expand_const_arrays (bool, default False) – if True and a const_value is provided, a fully expanded array is added to the model instead of a const array

  • points (bool, default False) – if True, this is a points property with an extra dimension of extent 3

  • extra_metadata (dict, optional) – any items in this dictionary are added as extra metadata to the new property

  • use_int32 (bool, default True) – if True, and the array a has int64 bit elements, they are written as 32 bit data to hdf5; if False, 64 bit data is written in that situation

  • new_epc_file (string, optional) – if None, the source epc_file is extended with the new property object; if present, a new epc file (& associated h5 file) is created to contain a copy of the grid and the new property

Returns:

uuid.UUID of newly created property object