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.
 
 
 
 
Timmy Huang 7a851a0c73 Add screenshot testing 2 years ago
.github/workflows Add screenshot testing 2 years ago
build try a simpler process 5 years ago
cli Added application/json content-type to v2 dataset responses 2 years ago
docs rebuild docs 2 years ago
docs-src Merge branch 'master' into 522-url-conf-intervals 2 years ago
examples update v2 minimal example JSON 3 years ago
scripts Finish Spanish translation 2 years ago
src Add screenshot testing 2 years ago
test Add screenshot testing 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 test: text-based dataset smoke test 2 years ago
.gitattributes Add git-lfs to be used (upcoming) snapshot images 2 years ago
.gitignore Add screenshot testing 2 years ago
.npmignore Fix `create-data-dir` script 3 years ago
.travis.yml Travis Ubuntu dist 2 years ago
CHANGELOG.md version bump to 2.13.0 for release 2 years ago
DEV_DOCS.md Add screenshot testing 2 years ago
LICENSE.txt Initial commit with license and readme. 6 years ago
README.md add GitHub CI workflow badge to README 2 years ago
auspice.js Add `auspice convert` to allow cli v1 -> v2 JSON conversion 3 years ago
babel.config.js optimize: add babel-lodash-loader 2 years ago
bundlesize.config.json Add bundlesize checks to CI 2 years ago
favicon.png updated logo 4 years ago
index.html feat: serve Lato font locally instead of using Google fonts API 3 years ago
index.js Allow auspice code to be imported via node's `require` 3 years ago
jest-puppeteer.config.js jest-test-setup 2 years ago
package-lock.json Add screenshot testing 2 years ago
package.json Add screenshot testing 2 years ago
puppeteer.config.js Add screenshot testing 2 years ago
puppeteer.setup.js Add screenshot testing 2 years ago
releaseNewVersion.sh [docs] include changelog 3 years ago
webpack.config.js update deps to fix security vulnerabilities 3 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 10+. 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=10
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
npm run get-narratives

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.