pybacktrack.write_backtrack_well

pybacktrack.write_backtrack_well(decompacted_wells, decompacted_wells_filename, well, *, well_attributes=None, decompacted_columns=pybacktrack.BACKTRACK_DEFAULT_DECOMPACTED_COLUMNS)

Write decompacted parameters as columns in a text file.

Parameters:

• decompacted_wells (sequence of pybacktrack.DecompactedWell) – The decompacted wells returned by pybacktrack.backtrack_well().

• decompacted_wells_filename (string) – Name of output text file.

• well (pybacktrack.Well) – The well to extract metadata from.

• well_attributes (dict, optional) – Optional attributes in pybacktrack.Well object to write to well file metadata. If specified then must be a dictionary mapping each attribute name to a metadata name. For example, {'longitude' : 'SiteLongitude', 'latitude' : 'SiteLatitude'}. will write well.longitude (if not None) to metadata ‘SiteLongitude’, etc. Not that the attributes must exist in well (but can be set to None).

• decompacted_columns (list of columns, optional) –

  The decompacted columns (and their order) to output to decompacted_wells_filename.

  Available columns are:

  • pybacktrack.BACKTRACK_COLUMN_AGE

  • pybacktrack.BACKTRACK_COLUMN_PALEO_LONGITUDE

  • pybacktrack.BACKTRACK_COLUMN_PALEO_LATITUDE

  • pybacktrack.BACKTRACK_COLUMN_COMPACTED_THICKNESS

  • pybacktrack.BACKTRACK_COLUMN_COMPACTED_DEPTH

  • pybacktrack.BACKTRACK_COLUMN_COMPACTED_DENSITY

  • pybacktrack.BACKTRACK_COLUMN_DECOMPACTED_THICKNESS

  • pybacktrack.BACKTRACK_COLUMN_DECOMPACTED_DENSITY

  • pybacktrack.BACKTRACK_COLUMN_DECOMPACTED_SEDIMENT_RATE

  • pybacktrack.BACKTRACK_COLUMN_DECOMPACTED_DEPTH

  • pybacktrack.BACKTRACK_COLUMN_DYNAMIC_TOPOGRAPHY

  • pybacktrack.BACKTRACK_COLUMN_TECTONIC_SUBSIDENCE

  • pybacktrack.BACKTRACK_COLUMN_WATER_DEPTH

  • pybacktrack.BACKTRACK_COLUMN_SEA_LEVEL

  • pybacktrack.BACKTRACK_COLUMN_COMPOSITE_POROSITY

  • pybacktrack.BACKTRACK_COLUMN_COMPOSITE_DECAY

  • pybacktrack.BACKTRACK_COLUMN_LITHOLOGY

Raises:

• ValueError – If an unrecognised value is encountered in decompacted_columns.

• ValueError – If pybacktrack.BACKTRACK_COLUMN_LITHOLOGY is specified in decompacted_columns but is not the last column.

Notes

Changed in version 1.5: The following changes were made:

• Added pybacktrack.BACKTRACK_COLUMN_PALEO_LONGITUDE, pybacktrack.BACKTRACK_COLUMN_PALEO_LATITUDE, pybacktrack.BACKTRACK_COLUMN_SEA_LEVEL, pybacktrack.BACKTRACK_COLUMN_COMPACTED_DENSITY, pybacktrack.BACKTRACK_COLUMN_COMPOSITE_POROSITY and pybacktrack.BACKTRACK_COLUMN_COMPOSITE_DECAY to available columns for decompacted_columns.

• Some arguments (after *) are now keyword-only (ie, can no longer be specified as positional arguments).