Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Describe all pymt methods in Usage section #59

Open
50 tasks
mdpiper opened this issue Feb 15, 2019 · 0 comments
Open
50 tasks

Describe all pymt methods in Usage section #59

mdpiper opened this issue Feb 15, 2019 · 0 comments

Comments

@mdpiper
Copy link
Member

mdpiper commented Feb 15, 2019

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
  • email
  • license
  • parameters
  • summary
  • url
  • version
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant