Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
xingyzt authored Mar 23, 2024
1 parent 3a4d9bc commit 0bc1336
Showing 1 changed file with 17 additions and 3 deletions.
20 changes: 17 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,18 @@
# DESI access via AWS
# Accessing cloud-hosted DESI data

A Docker environment for running DESI code and analyzing AWS-hosted DESI data.
DESI's early data release (EDR) will soon be made publicly accessible through an S3 cloud storage "bucket" on Amazon Web Services (AWS).
You can directly download the data at _insert url_.
However, we recommend accessing this data through this repository's Docker image,
a self-contained code environment which comes pre-packaged with
* A filesystem mounted to the DESI S3 bucket, which automatically downloads the data you query and nothing more
* A Jupyter server installed with general Python libraries for scientific programming, as well as DESI-specific libraries.

## Obtaining AWS credentials
You can either run this image locally or on a cloud compute instance, such as AWS EC2.
Below, we will provide instructions for both use cases.

## Getting started

### Obtaining AWS credentials

1. Create an AWS account
2. Follow the steps at [How to backup to S3 CLI](https://aws.amazon.com/getting-started/hands-on/backup-to-s3-cli/)
Expand All @@ -19,6 +29,10 @@ A Docker environment for running DESI code and analyzing AWS-hosted DESI data.
```
Save these changes to your file.

## Setting up an EC2 instance (Optional)

If you wish to run this Docker container

## Running the DESI- and AWS-equipped Jupyter container

1. Install Docker
Expand Down

0 comments on commit 0bc1336

Please sign in to comment.