openmpi/orte/bindings/python/README

===========================================================================
CFFI based Python wrapper for ORTE
===========================================================================


Example
-------

This example starts up a persistent DVM and then spawns some tasks using
Python.

$ virtualenv ve
$ source ve/bin/activate
$ pip install orte-cffi
$ orte-dvm --report-uri dvm_uri
$ python examples/submit.py


Create a distfile
----------------------------------------

If you want to create a sdist file:

$ virtualenv ve
$ source ve/bin/activate
$ python setup.py sdist


Uploading sdist to pypi
-----------------------

Assuming you have admin privileges to the pypi package repository for this
package, a new version can be uploaded using twine:

$ virtualenv ve
$ source ve/bin/activate
$ pip install twine
$ twine upload dist/orte-cffi-`python setup.py --version`.tar.gz


Building (for development purposes only)
----------------------------------------

If you want to create a non-pip build:

$ virtualenv ve
$ source ve/bin/activate
$ pip install cffi
$ python src/orte-cffi/build.py
Refactor the ORTE DVM code so that external codes can submit multiple jobs using only a single connection to the HNP. * Clean up the DVM so it continues to run even when applications error out and we would ordinarily abort the daemons. * Create a new errmgr component for the DVM to handle the differences. * Cleanup the DVM state component. * Add ORTE bindings directory and brief README * Pass a local tool index around to match jobs. * Pass the jobid on job completion. * Fix initialization logic. * Add framework for python wrapper. * Fix terminate-with-non-zero-exit behavior so it properly terminates only the indicated procs, notifies orte-submit, and orte-dvm continues executing. * Add some missing options to orte-dvm * Fix a bug in -host processing that caused us to ignore the #slots designator. Add a new attribute to indicate "do not expand the DVM" when submitting job spawn requests. * It actually makes no sense that we treat the termination of all children differently than terminating the children of a specific job - it only creates confusion over the difference in behavior. So terminate children the same way regardless. Extend the cmd_line utility to easily allow layering of command line definitions Catch up with ORTE interface change and make build more generic. Disable "fixed dvm" logic for now. Add another cmd_line function to merge a table of cmd line options with another one, reporting as errors any duplicate entries. Use this to allow orterun to reuse the orted_submit code Fix the "fixed_dvm" logic by ensuring we reset num_new_daemons to zero. Also ensure that the nidmap is sent with the first job so the downstream daemons get the node info. Remove a duplicate cmd line entry in orterun. Revise the DVM startup procedure to pass the nidmap only once, at the startup of the DVM. This reduces the overhead on each job launch and ensures that the nidmap doesn't get overwritten. Add new commands to get_orted_comm_cmd_str(). Move ORTE command line options to orte_globals.[ch]. Catch up with extra orte_submit_init parameter. Add example code. Add documentation. Bump version. The nidmap and routing data must be updated prior to propagating the xcast or else the xcast will fail. Fix the return code so it is something more expected when an error occurs. Ensure we get an error returned to us when we fail to launch for some reason. In this case, we will always get a launch_cb as we did indeed attempt to spawn it. The error code will be returned in the complete_cb. Fix the return code from orte_submit_job - it was returning the tracker index instead of "success". Take advantage of ORTE's pretty-print capabilities to provide a nice error output explaining why we failed to launch. Ensure we always get a launch_cb when we fail to launch, but no complete_cb as the job never launched. Extend the error reporting capability to job completion as well. Add index parameter to orte_submit_job(). Add orte_job_cancel and implement ORTE_DAEMON_TERMINATE_JOB_CMD. Factor out dvm termination. Parse the terminate option at tool level. Add error string for ORTE_ERR_JOB_CANCELLED. Add some safeguards. Cleanup and/of comments. Enable the return. Properly ORTE_DECLSPEC orte_submit_halt. Add orte_submit_halt and orte_submit_cancel to interface. Use the plm interface to terminate the job 2015-12-17 02:30:40 +03:00			`===========================================================================`
			`CFFI based Python wrapper for ORTE`
			`===========================================================================`


			`Example`
			`-------`

			`This example starts up a persistent DVM and then spawns some tasks using`
			`Python.`

			`$ virtualenv ve`
			`$ source ve/bin/activate`
			`$ pip install orte-cffi`
			`$ orte-dvm --report-uri dvm_uri`
			`$ python examples/submit.py`


			`Create a distfile`
			`----------------------------------------`

			`If you want to create a sdist file:`

			`$ virtualenv ve`
			`$ source ve/bin/activate`
			`$ python setup.py sdist`


			`Uploading sdist to pypi`
			`-----------------------`

			`Assuming you have admin privileges to the pypi package repository for this`
			`package, a new version can be uploaded using twine:`

			`$ virtualenv ve`
			`$ source ve/bin/activate`
			`$ pip install twine`
			$ twine upload dist/orte-cffi-`python setup.py --version`.tar.gz


			`Building (for development purposes only)`
			`----------------------------------------`

			`If you want to create a non-pip build:`

			`$ virtualenv ve`
			`$ source ve/bin/activate`
			`$ pip install cffi`
			`$ python src/orte-cffi/build.py`