Skip to content

Commit

Permalink
Update top-level README
Browse files Browse the repository at this point in the history
  • Loading branch information
kimandrews committed Jul 18, 2024
1 parent 81cd34e commit ecd309c
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,25 @@
# Nextstrain repository for rabies virus
This repository contains two workflows for the analysis of rabies virus data:

This repo is under development.
- [`ingest/`](./ingest) - Download data from GenBank, clean and curate it and upload it to S3
- [`phylogenetic/`](./phylogenetic) - Filter sequences, align, construct phylogeny and export for visualization

Each folder contains a README.md with more information. The results of running both workflows are publicly visible at [nextstrain.org/rabies](https://nextstrain.org/rabies).

## Installation

Follow the [standard installation instructions](https://docs.nextstrain.org/en/latest/install.html) for Nextstrain's suite of software tools.

## Quickstart

Run the default phylogenetic workflow via:
```
cd phylogenetic/
nextstrain build .
nextstrain view .
```

## Documentation

- [Running a pathogen workflow](https://docs.nextstrain.org/en/latest/tutorials/running-a-workflow.html)
- [Contributor documentation](./CONTRIBUTING.md)

0 comments on commit ecd309c

Please sign in to comment.