1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
|
API Reference guide
*******************
Core
====
.. autosummary::
:toctree: stubs
:nosignatures:
parsl.app.app.python_app
parsl.app.app.bash_app
parsl.app.app.join_app
parsl.dataflow.futures.AppFuture
parsl.dataflow.dflow.DataFlowKernelLoader
parsl.monitoring.MonitoringHub
parsl.dataflow.dependency_resolvers.DependencyResolver
parsl.dataflow.dependency_resolvers.DEEP_DEPENDENCY_RESOLVER
parsl.dataflow.dependency_resolvers.SHALLOW_DEPENDENCY_RESOLVER
Configuration
=============
.. autosummary::
:toctree: stubs
:nosignatures:
parsl.config.Config
parsl.set_stream_logger
parsl.set_file_logger
parsl.addresses.address_by_hostname
parsl.addresses.address_by_interface
parsl.addresses.address_by_query
parsl.addresses.address_by_route
parsl.addresses.get_all_addresses
parsl.addresses.get_any_address
parsl.utils.get_all_checkpoints
parsl.utils.get_last_checkpoint
Channels
========
Channels are deprecated in Parsl. See
`issue 3515 <https://github.com/Parsl/parsl/issues/3515>`_
for further discussion.
Data management
===============
.. autosummary::
:toctree: stubs
:nosignatures:
parsl.app.futures.DataFuture
parsl.data_provider.data_manager.DataManager
parsl.data_provider.staging.Staging
parsl.data_provider.files.File
parsl.data_provider.ftp.FTPSeparateTaskStaging
parsl.data_provider.ftp.FTPInTaskStaging
parsl.data_provider.file_noop.NoOpFileStaging
parsl.data_provider.globus.GlobusStaging
parsl.data_provider.http.HTTPSeparateTaskStaging
parsl.data_provider.http.HTTPInTaskStaging
parsl.data_provider.rsync.RSyncStaging
Executors
=========
.. autosummary::
:toctree: stubs
:nosignatures:
parsl.executors.base.ParslExecutor
parsl.executors.status_handling.BlockProviderExecutor
parsl.executors.ThreadPoolExecutor
parsl.executors.HighThroughputExecutor
parsl.executors.MPIExecutor
parsl.executors.WorkQueueExecutor
parsl.executors.taskvine.TaskVineExecutor
parsl.executors.FluxExecutor
parsl.executors.radical.RadicalPilotExecutor
Manager Selectors
=================
.. autosummary::
:toctree: stubs
:nosignatures:
parsl.executors.high_throughput.manager_selector.RandomManagerSelector
parsl.executors.high_throughput.manager_selector.BlockIdManagerSelector
Launchers
=========
.. autosummary::
:toctree: stubs
:nosignatures:
parsl.launchers.base.Launcher
parsl.launchers.SimpleLauncher
parsl.launchers.SingleNodeLauncher
parsl.launchers.SrunLauncher
parsl.launchers.AprunLauncher
parsl.launchers.SrunMPILauncher
parsl.launchers.GnuParallelLauncher
parsl.launchers.MpiExecLauncher
parsl.launchers.MpiRunLauncher
parsl.launchers.JsrunLauncher
parsl.launchers.WrappedLauncher
Providers
=========
.. autosummary::
:toctree: stubs
:nosignatures:
parsl.providers.AWSProvider
parsl.providers.CondorProvider
parsl.providers.GoogleCloudProvider
parsl.providers.GridEngineProvider
parsl.providers.LocalProvider
parsl.providers.LSFProvider
parsl.providers.SlurmProvider
parsl.providers.TorqueProvider
parsl.providers.KubernetesProvider
parsl.providers.PBSProProvider
parsl.providers.base.ExecutionProvider
parsl.providers.cluster_provider.ClusterProvider
Batch jobs
==========
.. autosummary::
:toctree: stubs
:nosignatures:
parsl.jobs.states.JobState
parsl.jobs.states.JobStatus
parsl.jobs.error_handlers.noop_error_handler
parsl.jobs.error_handlers.simple_error_handler
parsl.jobs.error_handlers.windowed_error_handler
Exceptions
==========
.. autosummary::
:toctree: stubs
:nosignatures:
parsl.app.errors.AppBadFormatting
parsl.app.errors.AppException
parsl.app.errors.AppTimeout
parsl.app.errors.BadStdStreamFile
parsl.app.errors.BashAppNoReturn
parsl.app.errors.BashExitFailure
parsl.app.errors.MissingOutputs
parsl.app.errors.ParslError
parsl.errors.ConfigurationError
parsl.errors.OptionalModuleMissing
parsl.executors.errors.ExecutorError
parsl.executors.errors.ScalingFailed
parsl.executors.errors.BadMessage
parsl.dataflow.errors.DataFlowException
parsl.dataflow.errors.BadCheckpoint
parsl.dataflow.errors.DependencyError
parsl.dataflow.errors.JoinError
parsl.launchers.errors.BadLauncher
parsl.providers.errors.ExecutionProviderException
parsl.providers.errors.ScaleOutFailed
parsl.providers.errors.SchedulerMissingArgs
parsl.providers.errors.ScriptPathError
parsl.executors.high_throughput.errors.WorkerLost
parsl.executors.high_throughput.interchange.ManagerLost
parsl.serialize.errors.DeserializationError
parsl.serialize.errors.SerializationError
Internal
========
.. autosummary::
:toctree: stubs
:nosignatures:
parsl.app.app.AppBase
parsl.app.bash.BashApp
parsl.app.python.PythonApp
parsl.dataflow.dflow.DataFlowKernel
parsl.dataflow.memoization.id_for_memo
parsl.dataflow.memoization.Memoizer
parsl.dataflow.states.FINAL_STATES
parsl.dataflow.states.States
parsl.dataflow.taskrecord.TaskRecord
parsl.jobs.job_status_poller.JobStatusPoller
parsl.jobs.strategy.Strategy
parsl.utils.Timer
Task Vine configuration
=======================
.. autosummary::
:toctree: stubs
:nosignatures:
parsl.executors.taskvine.TaskVineManagerConfig
parsl.executors.taskvine.TaskVineFactoryConfig
|