Create examples for teams/collectives interface

gmegan commented 5 years ago

The following is a list of tasks to get a comprehensive set of examples of the new teams API. Most of the tasks are just routine names, indicating that some example needs to demonstrate the correct use of the routine. Other tasks are more generic.

There does not need to be a one-to-one ratio of examples to tasks. Some tasks could potentially be merged into a single example. This list was made to be a guideline. Some tasks are marked with "?" to indicate that they do not seem critical to have in the document.

Examples should be submitted as PRs to the teams branch in this repo, with the example code under the "example_code" directory and any relevant include statements in an appropriate place in the document.

Team Management Routines:

[x] shmem_team_translate (includes shmem_team_my_pe, shmem_team_n_pes)
[x] shmem_team_split_strided (includes shmem_team_config usage for default values)
[x] shmem_team_split_2D
[x] shmem_team_create_ctx (includes shmem_team_config for num_contexts, and shmem_team_ctx_destroy, shmem_team_destroy ordering)
[x] ? Error handling example for failure to create context (can include shmem_team_get_ctx to check max # of allowed contexts)

RMA:

[x] Put/get using team context with team PE numbering
[x] ? Put/get using non-team context with team PE numbers (Issue #69)

Collective Routines:

[x] Remove all Fortran collective examples
[x] shmem_team_sync
[x] shmem_team_broadcast
[x] shmem_team_collect
[x] shmem_team_sum_to_all
[ ] ? Multithreading example with common pitfalls(clean up the broadcast example that we went over in WG call)

Other

[ ] Back to back collectives, iterative solver pattern

gmegan commented 5 years ago

Some places for existing teams code, which may not match current spec: https://gitlab.com/gmegan/openshmem-examples https://github.com/openshmem-org/shmemx-cray-tests

naveen-rn commented 5 years ago

We have already removed all the Fortran interface in https://github.com/openshmem-org/specification/pull/255 - so it would either be easy to cherry-pick changes or we could wait for that PR to be merged

gmegan / specification