Global NPM install
Auspice is avaliable as a npm package and can be installed simply via:
npm install --global auspice
Auspice is now available as a command-line program -- check by running
Documentation for how to run auspice locally is available here.
Installing as a project's dependency
If you are building a customised version of auspice, you may want to include it as a dependency of that project. This allows you to pin the version, use continuous integration tooling and simplifies any code imports you may wish to use.
npm install --save auspice
auspiceis not available as a command line tool this way, but can be accessed from within the repo via
npx auspice. See customising auspice for more information.
Installing from source
git clone firstname.lastname@example.org:nextstrain/auspice.git cd auspice npm install # install dependencies npm install -g . # make "auspice" available globally
Note that (at least on MacOS) this symlinks the source directory into the global
node_modules folder so that changes to source code are automatically reflected in the globally available
We have had good success using a conda environment for development.
Install auspice from source (see above). Running auspice in development mode will automatically update as you change the source code:
auspice develop --verbose
auspice develop -h for further options)
Install auspice from source (see above).
auspice build --verbose
auspice build -h for further options)