.. _mod_submit:

:mod:`hypershell.submit`
========================

.. module:: hypershell.submit
    :platform: Unix, Windows

|

Directly embed submit capabilities either as a dedicated :class:`SubmitThread`, :class:`LiveSubmitThread`,
or using one of the provided high-level functions, :meth:`submit_from`, :meth:`submit_file`.

All of the parameters used below are largely the same in each instance. Configuration files have
no impact when using the library; i.e., default values are not overridden by configuration.

-------------------

Functions
---------

|

.. autofunction:: submit_from

|

.. autofunction:: submit_file

-------------------

Classes
-------

|

.. autoclass:: SubmitThread
    :show-inheritance:

    .. automethod:: new
    .. automethod:: start
    .. automethod:: join
    .. automethod:: stop

|

.. autoclass:: LiveSubmitThread
    :show-inheritance:

    .. automethod:: new
    .. automethod:: start
    .. automethod:: join
    .. automethod:: stop

-------------------

Constants
---------

|

.. autodata:: DEFAULT_BUNDLESIZE
.. autodata:: DEFAULT_BUNDLEWAIT

|