- Download and unzip one of our datasets.
- Install Docker. Make sure you install the CLI as a part of this.
- Open substrate.config.yaml and set the
data.source
andbraid.directory
.data.source
should be set to the directory containing the dataset. - Set
braid.file_pattern
based upon your chosen dataset. For example,UGRD-1yr-720x361-fcst0.tgz
requiresbraid.file_pattern
to beUGRD-1yr-720x361-fcst0-*of*_*of*_*of*_*of*.dat
. - Uncomment the
docker
options and modify them if desired. - Run
./run.sh start
to launch the demo and./run.sh stop
to destroy it. - If you are running an older version of Docker, it may be necessary to run in privileged mode with
./run.sh --privileged start/stop
.
- Install Docker. Make sure you install the CLI as a part of this.
- Open substrate.config.yaml and set
braid.directory
. - Set
braid.file_pattern to match your chosen dataset. An example of how to correlate the chosen dataset from S3 is given in the provided
substrate.config.yaml`. - Uncomment the
aws
options and setaws.bucket
. Note thataws.bucket
must correspond to a unique bucket name across all S3 buckets (including other peoples' buckets). - Run
./run.sh --env AWS_ACCESS_KEY_ID={{YOUR_ACCESS_KEY_ID}} --env AWS_SECRET_ACCESS_KEY={{YOUR_ACCESS_KEY}} start
to deploy the demo and./run.sh --env --env AWS_ACCESS_KEY_ID={{YOUR_ACCESS_KEY_ID}} --env AWS_SECRET_ACCESS_KEY={{YOUR_ACCESS_KEY}} stop
to destroy it. - If your AWS credentials include a session token, make sure to include it in the above command as
--env AWS_SESSION_TOKEN={{YOUR_SESSION_TOKEN}}
. - If you are running an older version of Docker, it may be necessary to run in privileged mode with
./run.sh --privileged start/stop
.
If you need to deploy the AWS instance with HTTPS support, then you will need to own a domain name which you can use for the demo. Once you have a domain name, the following high-level steps will be necessary to run over HTTPS.
- Uncomment the
aws.https
option in substrate.config.yaml. This will create an Application Load Balancer for the demo which can be associated with an SSL certificate. - Using the AWS Certificate Manager, request an SSL certificate for the demo instance.
- Open the EC2 Load Balancer panel in the AWS console, select the load balancer for the demo, and then modify the listener to listen on port 443 (you'll also be asked to add the SSL cert you requested to the load balancer at this point).
- Update the domain's DNS records to point to the load balancer.