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.
 
 
 
 
Njagi Mwaniki 562958ac44
Add genenetwork navbar, splash screen and config
1 month ago
.github/workflows Move to storing test narratives in the auspice repo 8 months ago
.null vendor bundles and hashes for long term caching 9 months ago
build try a simpler process 3 years ago
cli Merge branch '1050-mult-narratives' 7 months ago
customizations Add genenetwork navbar, splash screen and config 1 month ago
docs Merge pull request #1261 from nextstrain/rotate-mapbox-token 1 month ago
examples update v2 minimal example JSON 1 year ago
narratives update test narrative 7 months ago
scripts Update get-data script to fetch root-sequence JSONs 4 months ago
src Add genenetwork header and footer 1 month ago
test disable (broken) smoke test for /ncov/global 1 month ago
.editorconfig lint & editor config 4 years ago
.eslintignore proxy requests through dev server to avoid cors for now 4 years ago
.eslintrc Disable ESLint's "no return await" rule 7 months ago
.gitattributes Add git-lfs to be used (upcoming) snapshot images 10 months ago
.gitignore Move to storing test narratives in the auspice repo 8 months ago
.npmignore Fix `create-data-dir` script 1 year ago
.travis.yml Travis Ubuntu dist 11 months ago
CHANGELOG.md version bump to 2.22.2 for release 1 month ago
DEV_DOCS.md Add warning to docs fetched by docs.nextstrain.org 3 months ago
LICENSE.txt Initial commit with license and readme. 4 years ago
README.md point to auspice stable docs instead of latest 3 months ago
auspice.js Add `auspice convert` to allow cli v1 -> v2 JSON conversion 1 year ago
babel.config.js set babel env for jest 9 months ago
bundlesize.config.json Add react-tooltip to vendors bundle 3 months ago
favicon.png updated logo 2 years ago
index.js [client-narratives] parse markdown client-side 7 months ago
jest-puppeteer.config.js jest-test-setup 11 months ago
package-lock.json update package-lock JSON 1 month ago
package.json version bump to 2.22.2 for release 1 month ago
puppeteer.config.js Add screenshot testing 10 months ago
puppeteer.setup.js Add screenshot testing 10 months ago
readthedocs.yml readthedocs config must be in root of project 5 months ago
releaseNewVersion.sh [docs] include changelog 1 year ago
webpack.config.js Update webpack chunk-hash-generation settings 1 month 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

The main Nextstrain documentation is available at docs.nextstrain.org. This includes tutorials, how-to guides, and explanations of concepts to help you get started and answer common questions to achieve your goal(s) with Auspice and other Nextstrain tools.

When getting started with Auspice, it may be helpful to read our overview of how Auspice fits together with other Nextstrain tools.

For more detailed technical information how Auspice works and reference guides describing specific Auspice features, check out the Auspice reference-guide documentation at docs.nextstrain.org/projects/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.