Added SDK document.

[mpratola]

No description provided.

[jared321]

You have a decision to make about how you add OpenBT within the bandframework repo. Do you want to add it as

1. a git submodule (example Taweret), in which case the SDK should be stored in this repo, or
2. a folder that contains files that point to this repo (example PUQ), in which case the SDK should be stored in that folder?

Personally, I am not a big fan of submodules, which need to be updated at each release. For (2), writing a sufficiently minimal README that is not tied to a specific release should be possible.

[jared321]

Some thoughts based on an initial pass.

[jared321]

Given that the design is geared toward command line tools rather than integrating your C++ code into a larger application, does this MPI requirement even apply to OpenBT? Would someone ever write a Python application that would want to assign only some of the MPI ranks to the openbt invocations of the C++ tools?

[mpratola]

I did not think that is the only use-case for communicators(?). But my knowledge is very little in that direction - removed.

[jared321]

Do you have a particular use case in mind?

I am focusing on

user-provided MPI communicator

which I assume means that the user has programmatic access to OpenBT so that they can create a communicator and pass all of that communicator or a proper subcommunicator to OpenBT for its use. In the OpenBT case, users only have the ability to run the program via mpirun/mpiexec, which does not provide programmatic access.

It might be worthwhile explaining this particular limitation since it is MPI-based.

[mpratola]

You have a decision to make about how you add OpenBT within the bandframework repo. Do you want to add it as

1. a git submodule (example Taweret), in which case the SDK should be stored in this repo, or
2. a folder that contains files that point to this repo (example PUQ), in which case the SDK should be stored in that folder?

Personally, I am not a big fan of submodules, which need to be updated at each release. For (2), writing a sufficiently minimal README that is not tied to a specific release should be possible.

If we do option #2, is there still a short-form URL to the OpenBT repo? The URL for PUQ is long and messy.

[jared321]

If we do option #2, is there still a short-form URL to the OpenBT repo? The URL for PUQ is long and messy.

Which PUQ URL are you referring to?