pybacktrack.write_well_file

pybacktrack.write_well_file(well, well_filename, *, other_column_attribute_names=None, well_attributes=None)

Writes a text file with each row representing a stratigraphic unit.

Parameters:
  • well (pybacktrack.Well) – The well to write.

  • well_filename (str) – Name of well text file.

  • other_column_attribute_names (sequence of str) – Names of any extra column attributes to write as column before the lithology(s) column. For example, backstripping will add min_water_depth and max_water_depth attributes (when pybacktrack.backstrip_well() or pybacktrack.backstrip_and_write_well() has been called, which in turn calls this function).

  • well_attributes (dict, 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).

Notes

Changed in version 1.5: Some arguments (after *) are now keyword-only (ie, can no longer be specified as positional arguments).