simpeg.utils.io_utils.write_dcip3d_ubc#

simpeg.utils.io_utils.write_dcip3d_ubc(file_name, data_object, data_type, file_type, format_type='general', comment_lines=None)[source]#

Write UBC-GIF DCIP3D formatted survey or data files.

This function can write survey locations, predicted data or observations files formatted for the UBC-GIF DCIP3D coding package. For more, see the UBC-GIF DCIP3D online manual.

Parameters:
file_namestr

file path for output file

data_object

simpeg.data.Data object. The survey attribute of this data object must be an instance of :class`simpeg.electromagnetics.static.resistivity.survey.Survey` or :class`simpeg.electromagnetics.static.induced_polarization.survey.Survey`

data_type{‘volt’, ‘apparent_chargeability’, ‘secondary_potential’}
file_type{‘survey’, ‘dpred’, ‘dobs’}
format_type{‘general’, ‘surface’}
comment_linesstr

Comments added to beginning of output file