Metadata-Version: 2.0
Name: rcluster
Version: 0.2.0
Summary: R clusters on AWS
Home-page: https://github.com/ElizabethAB/rcluster
Author: Elizabeth Byerly
Author-email: elizabeth.byerly@gmail.com
License: MIT
Keywords: r aws cluster cloud
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: System Administrators
Classifier: Topic :: System :: Clustering
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: System :: Systems Administration
Requires-Dist: boto3
Requires-Dist: paramiko
Provides-Extra: dev
Requires-Dist: coverage; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'

rcluster makes launching and accessing an R cluster on AWS simple and
accessible.

This repository will:

* Create master and worker AMIs saved to your AWS registry
* Allow you to launch a master and a stated number of worker nodes, automating
  the network connections between them and hosting a common NFS-based home
  folder under the default `cluster:cluster-base-password` user:
    * /home/cluster is shared between master and all workers
    * /home/cluster/hostfile contains the IPs of accessible worker nodes and
      spare master nodes, repeated based on the number of available worker cores
    * `cluster` user's .Rprofile defines an R function (`defaultCluster()`)
      which will reference the hostfile to create a PSOCK-based cluster

After that, login to RStudio Server as normal on the master, run
`defaultCluster()`, and use the returned parallel cluster object with
`parLapply()` and its peers.


# Getting Started

First, you must create and save locally your AWS access key ID and secret access
key ([instructions](http://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSGettingStartedGuide/AWSCredentials.html)).

Next, run `rcluster-config` from your command line. Note that this function
will, by default, write your AWS access key and secret access key to a hidden
folder in your user directory.

There are currently three functions to launch and manage an R cluster:

* `rcluster` - Launch an R cluster on AWS using the default configuration file.
* `rcluster-open` - Access an active R cluster (opens a new tab in your web
    browser to the RStudio Server instance, if available).
* `rcluster-terminate` - Terminate all instances associated with your `rcluster`
    configuration.


