Software to interface with AWS through convenient command line inputs, ultimately connecting into Relion-2.0's GUI to launch cloud processing from local Relion-2.0 GUI.
To learn more: cryoem-tools.cloud
See below for advanced installation instructions. To use a downloader script, please see more here
Contents:
You'll need to install pip, aws cli, cryptography, and fabric:
- pip: * https://pypi.python.org/pypi/pip
- aws cli:
* http://docs.aws.amazon.com/cli/latest/userguide/installing.html#install-with-pip
*
$ sudo pip install awscli
- fabric:
* http://www.fabfile.org/installing.html
*
$ sudo pip install fabric
Clone git repository:
https://github.com/cianfrocco-lab/cryoem-cloud-tools
Edit file cryoem-cloud-tools/aws/aws_init.sh to include AWS credentials. Consider moving out of cryoem-cloud-tools folder so that it does not get over written when you update the git repo.
With this file location, add the following line to your .cshrc / .bashrc / .bash_profile:
source /path/to/aws_init.sh
You will also need to include your AWS keypair path in aws_init.sh. Copy keypair into this new directory, double checking that this path is in the /home/[user]/.aws/aws_init.sh correctly. Also, make sure to modify permissions of file using:
$ chmod 600 /path/to/keypair.pem
For MacOSX users:
We compiled all python code into the directory aws_build_osx so that users do not need to install fabric (which sometimes can be a hassle).
- If you use this library on your Mac, use file aws_aliases_osx.sh instead of aws_aliases.sh in your aws_inith.sh script
- This repo also comes with Relion-2.0 pre-compiled for Mac (see below)
- Relion-2.0: We also included a compiled Relion-2.0 version compatible for Mac OSX that can be found in cryoem-cloud-tools/external_software/relion-2.0-mac
In using these wrappers, we typically use only a few of the commands for booting up & terminating instances.
You will store and process your data on EBS volumes, so to create an EBS volume you specify the volume size (in Gigabytes) and the availability zone (keep in mind that your initial setup above assumes a certain region). This amount of data storage is static, so, after creating it is very difficult to expand the size. Choose the size wisely!
$ aws_ebs_create Usage: aws_ebs_create [size in GB] [zone] "Description in double quotes"
$ aws_ebs_create 100 us-west-2c "My shiny data" Create volume in us-west-2c that is 100 GB? [Y/n] Y Creating volume ...
You will now see this in your list of AWS resources:
$ awsls ---------------------------------------------------------------------------------------------------------- Volume ID Description Avail. Zone Size User Status Instance ---------------------------------------------------------------------------------------------------------- vol-85cb3210 My shiny data us-west-2c 100GB mike_oregon available --
At this point, we recommend p2 instances for particle picking / ctf estimation (p2.xlarge), 2D classification (p2.16xlarge), and 3D classification/refinement (p2.8xlarge). To start one of these instances with your EBS volume attached:
$ awslaunch --instance=p2.8xlarge --availZone=us-west-2c --volume=vol-85cb3210
Note: If you want to upload data, use p2.8xlarge ($0.90/hr) or c4.xlarge ($0.199/hr).
After running this command, the log in information will be shown on the command line or you can always see it using:
$ awsls AWS EC2 information for user mike_oregon in region us-west-2 ---------------------------------------------------------------------------------------------------- InstanceType Avail. Zone InstanceID Status User Login info ---------------------------------------------------------------------------------------------------- p2.8xlarge us-west-2c i-98sdkfksdf9ssd9 running mike_oregon ssh -X -i /home/michaelc/.aws/mike_oregon.pem [email protected]
To log on, just copy the ssh information into your command line:
$ ssh -X -i /home/michaelc/.aws/mike_oregon.pem [email protected]
And it will log you onto your machine.
Your data will be located in the folder /data/:
To access:
$ cd /data
When you are finished analyzing your data, you can terminate your instance using:
$ awskill Usage: awskill [instance ID or cluster name]
To kill your instance:
$ awskill i-98sdkfksdf9ssd9
Note: If there are any running processes such as a relion GUI or an open terminal, it cannot terminate the instance. Kill / stop these processes and then try again.
The underlying code is written in python and aliased to simple commands: awsls, awslaunch, awskill.
-
awsls
- Lists all instances & volumes assigned to user, where user instances are assigned based upon being tagged with key pair name as the instance Owner.
- Include -i to only show instances that are running
- Include -v to only show EBS volumes
- Include -c to include listings of any clusters created with STARcluster
- Example usage:
$ awsls --------------------------------------------------------------------------------------- ReservedInstanceType Avail. Zone InstanceID Status IP Address User --------------------------------------------------------------------------------------- No instances found ---------------------------------------------------------------------------------------------------------------------------------------- SpotInstanceType Avail. Zone SpotInstanceID SpotStatus InstanceID Status IP Address Price User ---------------------------------------------------------------------------------------------------------------------------------------- m3.medium us-west-2a sir-b6dg94hn closed --- --- --- $0.040 mike_oregon ---------------------------------------------------------------------------------------- Volume ID Avail. Zone Size User Status Instance ---------------------------------------------------------------------------------------- vol-169efda2 us-west-2a 400GB mike_oregon available --
-
awslaunch
- Command to launch instance, configuring security group into VPC automatically to only allow users IP address for incoming SSH traffic.
- Example usage:
$ awslaunch Usage: awslaunch --instance= Options: -h, --help show this help message and exit --instance=STRING Specify instance type to launch --availZone=STRING Specify availability zone --spotPrice=FLOAT Optional: Specify spot price (if spot instance requested) --volume=STRING Optional: Specifiy volume ID to be mounted onto instance (Must be same avail. zone) --relion2 Optional: Flag to use relion2 environment on non-GPU machines (By default, relion2 software is only loaded onto GPU (p2) instances) --rosetta Optional: Flag to use rosetta environment (Rosetta runs on CPUs) --instanceList Flag to list available instances -d debug$ awslaunch --instance=t2.micro Launching AWS instance t2.micro for user keyName_virginia Configuring security settings ... Booting up instance ... Waiting for instance to pass system checks ... Instance is ready! To log in: ssh -i /home/[user]/.aws/keyName_virginia.pem [email protected]
-
awskill
- Command to terminate running instance or STARcluster
- Example usage:
$ awskill Usage: awskill [instance ID] Specify instance ID that will be terminated, which can be found using "awsls"
$ awskill i-112k43e Terminate instance i-112k43e? [Y/n] Y Removing instance ...
$ awskill cluster-m3.medium
-
aws_ebs_create
- Command to create new EBS volume
- Example usage:
$ aws_ebs_create Usage: aws_ebs_create [size in GB] [zone] Specify size of EBS volume to be created (in GB) along with availability zone (e.g. us-east-1b)
$ aws_ebs_create 100 us-east-1b
-
aws_ebs_delete
- Command to delete EBS volume. Be careful! This cannot be undone.
- Example usage:
$ aws_ebs_delete Usage: aws_ebs_delete [volume ID] Specify EBS volume to delete. Warning: Cannot be undone!!
$ aws_ebs_delete vol-id559699
-
aws_ebs_attach
- Command to attach EBS volume to running instance.
- Example usage:
$ aws_ebs_attach Usage: aws_ebs_attach [instance ID] [volume ID] Attach EBS volume to instance.
$ aws_ebs_attach i-112k43e vol-id559699
-
aws_ebs_detach
- Command to attach EBS volume to running instance.
- Example usage:
$ aws_ebs_detach Usage: aws_ebs_detach [volume ID] Detach EBS volume from instance.
$ aws_ebs_detach vol-id559699
- Example usage:
- Command to attach EBS volume to running instance.
-
awslaunch_cluster * Command to launch a cluster of instances using STARcluster. Note: Must have starcluster already installed (see above for install info). * Example usage:
$ awslaunch_cluster Usage: awslaunch_cluster --instance= Options: -h, --help show this help message and exit --instance=STRING Specify instance type to launch into cluster --num=INTEGER Number of instances in cluster --availZone=STRING Specify availability zone --volume=STRING Optional: Volume ID for volume that will be mounted onto cluster --spotPrice=FLOAT Optional: Specify spot price (if spot instance requested) --instanceList Flag to list available instances -d debug
$ awslaunch_cluster --instance=c3.xlarge --num=4 --availZone=us-west-2a --spotPrice=0.2
-
aws_spot_price_history * Command to list spot prices over the past 24 hours * Example usage:
$ aws_spot_price_history Usage: aws_spot_price_history [instance type] [avail. zone] Specify instance type over which spot price history will be listed based upon availability zone
$ aws_spot_price_history m3.meduim us-west-2a
During the course of processing, this workflow will temporarily place data onto S3 and EBS volumes to speed up data processing. This data can be removed by running the command:
$ delete_temp_s3_ebs
This will remove all S3 buckets and EBS volumes that have the naming pattern: rln-aws-tmp.
All buckets and volumes will be removed based upon the number of days specified in your aws_init.sh file, where any bucket or volume older than the specified time will be removed.