7.3.7. Export Module

export module

This module capture all core ParFlow exporters.

class parflow.tools.export.CLMExporter(run)

Bases: object

__init__(run)
property can_export
write(working_directory='.', **kwargs)

Method to export all clm files based on metadata

Parameters:

working_directory='.' (-) – specifies where the files will be written

write_allowed(working_directory='.', **kwargs)

Export files we are allowed to overwrite

Parameters:

working_directory='.' (-) – specifies where the files will be written

write_input(working_directory='.')

Method to export drv_clmin.dat file based on metadata

Parameters:

working_directory='.' (-) – specifies where drv_climin.dat file will be written

write_map(vegm_array=None, working_directory='.', dec_round=3)
Method to export drv_vegm.dat file based on keys or a 3D array of

data

Parameters:
  • vegm_array=None (-) – optional full array with gridded properties to export. If None, the array will be generated automatically from the run object.

  • working_directory='.' (-) – specifies where drv_vegm.dat file will be written

  • dec_round=3 (-) – sets the maximum decimal rounding for the lat, long, sand, and clay parameters.

write_parameters(vegp_data=None, working_directory='.')

Method to export drv_vegp.dat file based on dictionary of data

Parameters:
  • vegp_data=None (-) – optional full dict to export. If None, it will automatically be generated from the run object.

  • working_directory='.' (-) – specifies where drv_vegp.dat file will be written

exception parflow.tools.export.NotOverwritableException

Bases: Exception

class parflow.tools.export.SubsurfacePropertiesExporter(run)

Bases: object

__init__(run)
get_table_as_txt(column_separator='  ', columns_justify=True)
write_csv(file_path)
write_txt(file_path)