Auspice fork from github of https://github.com/urbanslug/auspice
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
eharkins 1a7b24ef2b docs build environment with deps 1 year ago
.github/workflows Move to storing test narratives in the auspice repo 2 years ago
.null vendor bundles and hashes for long term caching 2 years ago
build try a simpler process 5 years ago
cli Merge branch '1050-mult-narratives' 2 years ago
docs docs build environment with deps 1 year ago
examples update v2 minimal example JSON 2 years ago
narratives update test narrative 1 year ago
scripts Move to storing test narratives in the auspice repo 2 years ago
src version bump to 2.18.4 for release 1 year ago
test [client-narratives] parse markdown client-side 2 years ago
.editorconfig lint & editor config 6 years ago
.eslintignore proxy requests through dev server to avoid cors for now 6 years ago
.eslintrc Disable ESLint's "no return await" rule 2 years ago
.gitattributes Add git-lfs to be used (upcoming) snapshot images 2 years ago
.gitignore Move to storing test narratives in the auspice repo 2 years ago
.npmignore Fix `create-data-dir` script 2 years ago
.travis.yml Travis Ubuntu dist 2 years ago
CHANGELOG.md Migrate Auspice docs from docusaurus to RTD 1 year ago
DEV_DOCS.md Migrate Auspice docs from docusaurus to RTD 1 year ago
LICENSE.txt Initial commit with license and readme. 6 years ago
README.md Move to storing test narratives in the auspice repo 2 years ago
auspice.js Add `auspice convert` to allow cli v1 -> v2 JSON conversion 3 years ago
babel.config.js set babel env for jest 2 years ago
bundlesize.config.json [client-narratives] update bundlesize config 2 years ago
favicon.png updated logo 3 years ago
index.js [client-narratives] parse markdown client-side 2 years ago
jest-puppeteer.config.js jest-test-setup 2 years ago
package-lock.json security fix: update deps via npm audit 1 year ago
package.json version bump to 2.18.4 for release 1 year ago
puppeteer.config.js Add screenshot testing 2 years ago
puppeteer.setup.js Add screenshot testing 2 years ago
releaseNewVersion.sh [docs] include changelog 2 years ago
webpack.config.js [client-narratives] change bundle structure to accommodate YAML parsing 2 years ago

README.md

Build Status GitHub CI Status NPM version License: AGPL v3

About Nextstrain

Nextstrain is an open-source project to harness the scientific and public health potential of pathogen genome data. We provide a continually-updated view of publicly available data with powerful analytics and visualizations showing pathogen evolution and epidemic spread. Our goal is to aid epidemiological understanding and improve outbreak response.

Resulting data and inferences are available live at the website nextstrain.org.

About Auspice

Definition: Observation by an augur, ie a prophetic sign.

Auspice is an open-source interactive web app for visualizing phylogenomic data. It may be used in tandem with nextstrain's bioinformatics toolkit augur or on its own. Auspice may be used to explore datasets locally or run as a server to share results.

Documentation

Full documentation may be found at: nextstrain.github.io/auspice. The following are helpful when beginning to use Auspice:

Quickstart

Installation

Install auspice for use as a global command. This requires nodejs. We recommend using a conda environment, but this is not the only way. (See here for more installation methods & help).

Create and activate a conda environment:

conda create --name auspice nodejs=12
conda activate auspice

Now that the conda environment is activated, install auspice:

npm install --global auspice

Install from source

git clone https://github.com/nextstrain/auspice.git
cd auspice
npm install --global .

Obtain datasets to display

To get up & running, you'll need datasets to visualise. (Please see the nextstrain docs for tutorials on how to run your own analyses.)

If you've installed auspice from npm you may get datasets to display via:

mkdir data
curl http://data.nextstrain.org/zika.json --compressed -o data/zika.json
curl http://data.nextstrain.org/ncov.json --compressed -o data/ncov.json
...

If you've installed auspice from source, we have helper scripts to make all the datasets & narratives you see on nextstrain.org available locally:

# from the auspice src directory
npm run get-data

Obtain narratives to view locally

This repository contains a number of "test narratives" which serve both to provide examples of the capability of narratives, as well as being used to test functionality and fix bugs. These should work out of the box, assuming you have obtained the necessary datasets via the above script.

If you wish to view the nextstrain-maintained narratives, then this can be done by checking out the nextstrain/narratives github repo and telling auspice to look for narratives there via the --narrativeDir argument.

Run auspice

auspice view --datasetDir data

And view auspice in the browser at localhost:4000

If you are editing source code, running the following command will allow hot-reloading.

auspice develop --datasetDir data

CLI (Command Line Interface)

Run auspice --help or auspice view --help to see all the available command line options.

Contributor Information

We have received a number of generous offers to contribute developer effort to nextstrain (and auspice) following our work on hCoV-19. We welcome contributions! To get started, please review these resources before submitting a pull request:

This project strictly adheres to the Contributor Covenant Code of Conduct.

Copyright 2014-2020 Trevor Bedford and Richard Neher.

Source code to Nextstrain is made available under the terms of the GNU Affero General Public License (AGPL). Nextstrain is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details.