Skip to content
This repository was archived by the owner on Aug 9, 2023. It is now read-only.

Commit b932108

Browse files
authored
Merge pull request #1 from aws-samples/develop
Major Overhaul
2 parents cb296d1 + e200a42 commit b932108

File tree

114 files changed

+1198
-3688
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

114 files changed

+1198
-3688
lines changed

README.md

Lines changed: 16 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,26 @@
1-
## Genomics Workflows
1+
# Genomics Workflows on AWS
22

3-
Genomics Workflows on AWS
3+
This repository is the source code for [Genomics Workflows on AWS](docs.opendata.aws/genomics-workflows). It contains markdown documents that are used to build the site as well as source code (CloudFormation templates, scripts, etc) that can be used to deploy AWS infrastructure for running genomics workflows.
44

5-
## License Summary
6-
7-
This sample code is made available under a modified MIT license. See the LICENSE file.
8-
9-
# Deploying reference architecture for the Cromwell workflow management system on AWS
10-
11-
This reference architecture provides a set of YAML templates for deploying AWS resources, such as [AWS Batch](http://aws.amazon.com/batch/), for use with the [Cromwell](http://cromwell.readthedocs.io) workflow management system.
12-
13-
## [Step 0.](id:step-0) Prerequisites
5+
## Building the documentation
146

15-
If you have not already all of the following:
7+
The documentation is built using mkdocs.
168

17-
1. Created a AWS account
18-
2. Created a IAM user with proper permissions
19-
3. Configured the AWS CLI
20-
3. Created and downloaded an EC2 Key Pair
21-
4. Are able to SSH into a Linux host
9+
Install dependencies:
2210

23-
Follow the [Prerequisites Guide](./doc/prereqs) to create these resources. All further instructions assume the above.
11+
```bash
12+
$ conda create --file enviroment.yaml
13+
```
2414

25-
## [Step 1.](id:step-1) Create a customer AMI for genomics on AWS
15+
This will create a `conda` environment called `mkdocs`
2616

27-
Genomics, the main use case for Cromwell, is a data-heavy workload and requires some modification to the standard AWS Batch processing environment. In particular, we need to scale underlying instance storage that Tasks/Jobs run on top of to meet unpredictable runtime demands.
17+
Build the docs:
2818

29-
Follow the directions in the ["Creating a custom AMI for genomics"](./doc/create-custom-ami.md) guide.
19+
```bash
20+
$ source activate mkdocs
21+
$ mkdocs build
22+
```
3023

31-
## [Step 2.](id:step-2) Launch and configure an AWS reference architecture for use with Cromwell
32-
33-
Once you have a custom AMI ID, such as `ami-a7a242da`, you can launch the reference architecture CloudFormation stack in your account, using one of the links below. A full description of what is going on is described in the ["Deploying AWS Batch"](./doc/cofigure-aws-batch-start.md) guide.
34-
35-
![AWS Batch environment for genomics](https://d2908q01vomqb2.cloudfront.net/1b6453892473a467d07372d45eb05abc2031647a/2018/04/23/Picture2.png)
36-
37-
## [Step 3.](id:step-3) Configuring Cromwell for AWS
38-
39-
Once you have a suitable AWS Batch environment for genomics workflows, you can leverage it with other systems, such as AWS Step Functions, [Cromwell](LINK), and [Nextflow.io](https://nextflow.io).
24+
## License Summary
4025

41-
* **[Configure AWS Lambda and AWS Step Functions](./docs/configure-aws-native.md)**
42-
* **[Configure Cromwell](./docs/configure-cromwell-aws-batch.md)**
43-
<!-- * **[Configure Nextflow.io](./configure-nextflow-aws-batch.md)** -->
26+
This sample code is made available under a modified MIT license. See the LICENSE file.

docs/aws-batch/configure-aws-batch-cfn.md

Lines changed: 0 additions & 59 deletions
This file was deleted.

docs/aws-batch/configure-aws-batch-start.md

Lines changed: 0 additions & 58 deletions
This file was deleted.

docs/aws-batch/create-custom-ami.md

Lines changed: 0 additions & 118 deletions
This file was deleted.
-20.5 KB
Binary file not shown.

0 commit comments

Comments
 (0)