API Reference
=============

Generated from the docstrings in the package. Only modules reachable from a live
code path are listed; ``network/``, ``compute/ec2.py``, and several ``utils``
modules are unreferenced by any current path and are scheduled for removal in
v0.8.0 (`#90 <https://github.com/scttfrdmn/parsl-ephemeral-provider/issues/90>`_).

Provider
--------

.. automodule:: parsl_ephemeral_provider.provider
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: parsl_ephemeral_provider.globus_compute
   :members:
   :undoc-members:
   :show-inheritance:

Operating modes
---------------

.. automodule:: parsl_ephemeral_provider.modes.base
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: parsl_ephemeral_provider.modes.standard
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: parsl_ephemeral_provider.modes.detached
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: parsl_ephemeral_provider.modes.serverless
   :members:
   :undoc-members:
   :show-inheritance:

Compute
-------

.. automodule:: parsl_ephemeral_provider.compute.spot_fleet
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: parsl_ephemeral_provider.compute.spot_interruption
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: parsl_ephemeral_provider.compute.lambda_func
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: parsl_ephemeral_provider.compute.ecs
   :members:
   :undoc-members:
   :show-inheritance:

State persistence
-----------------

.. automodule:: parsl_ephemeral_provider.state.base
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: parsl_ephemeral_provider.state.file
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: parsl_ephemeral_provider.state.s3
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: parsl_ephemeral_provider.state.parameter_store
   :members:
   :undoc-members:
   :show-inheritance:

Support modules
---------------

.. automodule:: parsl_ephemeral_provider.constants
   :members:
   :undoc-members:

.. automodule:: parsl_ephemeral_provider.exceptions
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: parsl_ephemeral_provider.error_handling
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: parsl_ephemeral_provider.utils.aws
   :members:
   :undoc-members: