Package: parallelly 1.41.0

parallelly: Enhancing the 'parallel' Package

Utility functions that enhance the 'parallel' package and support the built-in parallel backends of the 'future' package. For example, availableCores() gives the number of CPU cores available to your R process as given by the operating system, 'cgroups' and Linux containers, R options, and environment variables, including those set by job schedulers on high-performance compute clusters. If none is set, it will fall back to parallel::detectCores(). Another example is makeClusterPSOCK(), which is backward compatible with parallel::makePSOCKcluster() while doing a better job in setting up remote cluster workers without the need for configuring the firewall to do port-forwarding to your local computer.

Authors:Henrik Bengtsson [aut, cre, cph], Mike Cheng [ctb]

parallelly_1.41.0.tar.gz
parallelly_1.41.0.zip(r-4.5)parallelly_1.41.0.zip(r-4.4)parallelly_1.41.0.zip(r-4.3)
parallelly_1.41.0.tgz(r-4.4-x86_64)parallelly_1.41.0.tgz(r-4.4-arm64)parallelly_1.41.0.tgz(r-4.3-x86_64)parallelly_1.41.0.tgz(r-4.3-arm64)
parallelly_1.41.0.tar.gz(r-4.5-noble)parallelly_1.41.0.tar.gz(r-4.4-noble)
parallelly_1.41.0.tgz(r-4.4-emscripten)parallelly_1.41.0.tgz(r-4.3-emscripten)
parallelly.pdf |parallelly.html
parallelly/json (API)
NEWS

# Install 'parallelly' in R:
install.packages('parallelly', repos = c('https://henrikbengtsson.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/futureverse/parallelly/issues

Pkgdown:https://parallelly.futureverse.org

On CRAN:

parallel-computing

14.23 score 131 stars 1.2k packages 448 scripts 327k downloads 26 exports 0 dependencies

Last updated 1 days agofrom:bf44f96182 (on master). Checks:OK: 8 ERROR: 1. Indexed: no.

TargetResultDate
Doc / VignettesOKDec 18 2024
R-4.5-win-x86_64OKDec 18 2024
R-4.5-linux-x86_64ERRORDec 18 2024
R-4.4-win-x86_64OKDec 18 2024
R-4.4-mac-x86_64OKDec 18 2024
R-4.4-mac-aarch64OKDec 18 2024
R-4.3-win-x86_64OKDec 18 2024
R-4.3-mac-x86_64OKDec 18 2024
R-4.3-mac-aarch64OKDec 18 2024

Exports:as.clusterautoStopClusteravailableConnectionsavailableCoresavailableWorkerscloneNodeconnectionIdcpuLoadfreeConnectionsfreeCoresfreePortisConnectionValidisForkedChildisForkedNodeisLocalhostNodeisNodeAlivekillNodemakeClusterMPImakeClusterPSOCKmakeClusterSequentialmakeNodePSOCKMPIPSOCKSEQserializedSizesupportsMulticore

Dependencies:

An Introduction to 'parallelly'

Rendered fromparallelly-01-intro.mdusingparallelly::selfonlyon Dec 18 2024.

Last update: 2024-12-03
Started: 2024-12-03

Parallel Workers in the Cloud

Rendered fromparallelly-15-cloud-workers.mdusingparallelly::selfonlyon Dec 18 2024.

Last update: 2024-12-03
Started: 2024-12-03

Parallel Workers on High-Performance Compute Environments

Rendered fromparallelly-17-hpc-workers.mdusingparallelly::selfonlyon Dec 18 2024.

Last update: 2024-12-03
Started: 2024-12-03

Parallel Workers on Other Machines

Rendered fromparallelly-12-remote-workers.mdusingparallelly::selfonlyon Dec 18 2024.

Last update: 2024-12-03
Started: 2024-12-03

Parallel Workers on the Local Machine

Rendered fromparallelly-10-local-workers.mdusingparallelly::selfonlyon Dec 18 2024.

Last update: 2024-12-03
Started: 2024-12-03

Parallel Workers Running in Linux Containers

Rendered fromparallelly-21-container-workers.mdusingparallelly::selfonlyon Dec 18 2024.

Last update: 2024-12-03
Started: 2024-12-03

Parallel Workers Running MS Windows via Wine

Rendered fromparallelly-22-wine-workers.mdusingparallelly::selfonlyon Dec 18 2024.

Last update: 2024-12-03
Started: 2024-12-03

Parallel Workers with CPU and Memory Limited

Rendered fromparallelly-20-limit-workers.mdusingparallelly::selfonlyon Dec 18 2024.

Last update: 2024-12-18
Started: 2024-12-03

Readme and manuals

Help Manual

Help pageTopics
Coerce an Object to a Cluster Objectas.cluster as.cluster.cluster as.cluster.list as.cluster.RichSOCKnode as.cluster.SOCK0node as.cluster.SOCKnode c.cluster
Automatically Stop a Cluster when Garbage CollectedautoStopCluster
Number of Available and Free ConnectionsavailableConnections freeConnections
Get Number of Available Cores on The Current MachineavailableCores
Get Set of Available WorkersavailableWorkers
Clone one or more nodescloneNode
Find a TCP port that can be openedfreePort
Checks if a Connection is ValidconnectionId isConnectionValid
Checks whether or not we are running in a forked child processisForkedChild
Checks whether or not a Cluster Node Runs in a Forked ProcessisForkedNode
Checks whether or not a Cluster Node Runs on LocalhostisLocalhostNode
Check whether or not the cluster nodes are aliveisNodeAlive
Terminate one or more cluster nodes using process signalingkillNode
Create a Message Passing Interface (MPI) Cluster of R Workers for Parallel ProcessingmakeClusterMPI MPI
Create a PSOCK Cluster of R Workers for Parallel ProcessingmakeClusterPSOCK makeNodePSOCK PSOCK
Create a "parallel" cluster running sequentially in the current sessionmakeClusterSequential SEQ
Options Used by the 'parallelly' Packagefuture.availableCores.custom future.availableCores.fallback future.availableCores.methods future.availableCores.system future.availableWorkers.custom future.availableWorkers.methods future.fork.enable future.supportsMulticore.unstable parallelly.availableCores.custom parallelly.availableCores.fallback parallelly.availableCores.methods parallelly.availableCores.min parallelly.availableCores.omit parallelly.availableCores.system parallelly.availableWorkers.custom parallelly.availableWorkers.methods parallelly.debug parallelly.fork.enable parallelly.makeNodePSOCK.connectTimeout parallelly.makeNodePSOCK.rshcmd parallelly.makeNodePSOCK.rshopts parallelly.makeNodePSOCK.setup_strategy parallelly.makeNodePSOCK.socketOptions parallelly.makeNodePSOCK.timeout parallelly.makeNodePSOCK.tries parallelly.makeNodePSOCK.tries.delay parallelly.makeNodePSOCK.useXDR parallelly.makeNodePSOCK.validate parallelly.maxWorkers.localhost parallelly.options parallelly.supportsMulticore.disableOn parallelly.supportsMulticore.unstable R_FUTURE_AVAILABLECORES_FALLBACK R_FUTURE_AVAILABLECORES_SYSTEM R_FUTURE_FORK_ENABLE R_FUTURE_SUPPORTSMULTICORE_UNSTABLE R_PARALLELLY_AVAILABLECORES_FALLBACK R_PARALLELLY_AVAILABLECORES_MIN R_PARALLELLY_AVAILABLECORES_OMIT R_PARALLELLY_AVAILABLECORES_SYSTEM R_PARALLELLY_FORK_ENABLE R_PARALLELLY_MAKENODEPSOCK_CONNECTTIMEOUT R_PARALLELLY_MAKENODEPSOCK_RSHCMD R_PARALLELLY_MAKENODEPSOCK_RSHOPTS R_PARALLELLY_MAKENODEPSOCK_SETUP_STRATEGY R_PARALLELLY_MAKENODEPSOCK_SOCKETOPTIONS R_PARALLELLY_MAKENODEPSOCK_TIMEOUT R_PARALLELLY_MAKENODEPSOCK_TRIES R_PARALLELLY_MAKENODEPSOCK_TRIES_DELAY R_PARALLELLY_MAKENODEPSOCK_USEXDR R_PARALLELLY_MAKENODEPSOCK_VALIDATE R_PARALLELLY_SUPPORTSMULTICORE_DISABLEON R_PARALLELLY_SUPPORTSMULTICORE_UNSTABLE
Calculate the size of an R object when it is serializedserializedSize
Check If Forked Processing ("multicore") is SupportedsupportsMulticore