Describe all pymt methods in Usage section #59
Description
The Usage section of the pymt docs is intended to give an overview of how to use pymt to configure, run, and couple models. It currently describes how to use the "primary" (my term) set of pymt functions, such as initialize, update, finalize, get_value, set_value, etc. However, to be truly useful, it should provide descriptions for all pymt functions and properties. Here's a list:
- map_to
- map_value
- regrid
- get_component_name
- get_grid_dim
- get_grid_face_node_connectivity
- get_grid_face_node_offset
- get_grid_face_nodes
- get_grid_ndim
- get_grid_nodes_per_face
- get_grid_number_of_faces
- get_grid_number_of_nodes
- get_grid_number_of_vertices
- get_grid_origin
- get_grid_rank
- get_grid_shape
- get_grid_size
- get_grid_spacing
- get_grid_type
- get_grid_x
- get_grid_y
- get_grid_z
- get_value_ptr
- get_var_grid
- get_var_grid_loc
- get_var_intent
- get_var_itemsize
- get_var_location
- get_var_nbytes
- get_var_type
- get_var_units
- quick_plot
- time_from
- time_in
- add_data
- interpolate
- reset
- update_until
Also properties:
- author
- cite_as
- contact
- datadir
- defaults
- doi
- license
- parameters
- summary
- url
- version