|
1 | | -## Genomics Workflows |
| 1 | +# Genomics Workflows on AWS |
2 | 2 |
|
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. |
4 | 4 |
|
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 |
14 | 6 |
|
15 | | -If you have not already all of the following: |
| 7 | +The documentation is built using mkdocs. |
16 | 8 |
|
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: |
22 | 10 |
|
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 | +``` |
24 | 14 |
|
25 | | -## [Step 1.](id:step-1) Create a customer AMI for genomics on AWS |
| 15 | +This will create a `conda` environment called `mkdocs` |
26 | 16 |
|
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: |
28 | 18 |
|
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 | +``` |
30 | 23 |
|
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 | | - |
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 |
40 | 25 |
|
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. |
0 commit comments