Skip to content

Commit

Permalink
Fix reST styling after conversion
Browse files Browse the repository at this point in the history
  • Loading branch information
victorlin committed Dec 5, 2022
1 parent f61093e commit fbd661c
Showing 1 changed file with 11 additions and 10 deletions.
21 changes: 11 additions & 10 deletions docs/introduction/install.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
===============
Install Auspice
===============

Prerequisites
-------------
=============

Auspice is a JavaScript program, and requires `Node.js <https://nodejs.org/>`__ to be installed on your system. Refer to ``engines.node`` in `package.json <https://github.com/nextstrain/auspice/blob/-/package.json>`__ for currently supported versions.

We highly recommend using `Conda <https://conda.io/docs/>`__ to manage environments, i.e. use Conda to create an environment with Node.js installed where you can use Auspice. Its possible to use other methods, but this documentation presupposes that you have Conda installed.
We highly recommend using `Conda <https://conda.io/docs/>`__ to manage environments, i.e. use Conda to create an environment with Node.js installed where you can use Auspice. It's possible to use other methods, but this documentation presupposes that you have Conda installed.

To run package scripts, the ```bash`` shell <https://en.wikipedia.org/wiki/Bash_(Unix_shell)>`__ and the ```env`` <https://en.wikipedia.org/wiki/Env>`__ command need to be in your ``PATH``. You should already have them on Unix-like systems including Linux and macOS. If you are working from Windows, you can run the installation under Git Bash, MSYS2, or Cygwin. You can also use the Windows Subsystem Linux for a fuller Linux environment.
To run package scripts, the `bash shell <https://en.wikipedia.org/wiki/Bash_(Unix_shell)>`__ and the `env <https://en.wikipedia.org/wiki/Env>`__ command need to be in your ``PATH``. You should already have them on Unix-like systems including Linux and macOS. If you are working from Windows, you can run the installation under Git Bash, MSYS2, or Cygwin. You can also use the Windows Subsystem Linux for a fuller Linux environment.

Create a Conda Environment
--------------------------
==========================

.. code:: bash
Expand All @@ -20,16 +21,16 @@ Create a Conda Environment
..
This parallels `the Nextstrain installation docs <https://nextstrain.org/docs/getting-started/local-installation#install-augur--auspice-with-conda-recommended>`__. Youre welcome to use those instead!
This parallels `the Nextstrain installation docs <https://nextstrain.org/docs/getting-started/local-installation#install-augur--auspice-with-conda-recommended>`__. You're welcome to use those instead!

Install Auspice from npm
------------------------
========================

.. code:: bash
npm install --global auspice
Auspice should now be available as a command-line program check by running ``auspice --help``.
Auspice should now be available as a command-line program - check by running ``auspice --help``.

If you look at the `release notes <https://docs.nextstrain.org/projects/auspice/en/stable/releases/changelog.html>`__ you can see the changes that have been made to Auspice (see your version of Auspice via ``auspice --version``). To upgrade, you can run

Expand All @@ -38,9 +39,9 @@ If you look at the `release notes <https://docs.nextstrain.org/projects/auspice/
npm update --global auspice
Installing from Source
----------------------
======================

This is useful for debugging, modifying the source code, or using an unpublished feature branch. Were going to assume that you have used Conda to install Node.js as above.
This is useful for debugging, modifying the source code, or using an unpublished feature branch. We're going to assume that you have used Conda to install Node.js as above.

.. code:: bash
Expand All @@ -64,4 +65,4 @@ This is useful for debugging, modifying the source code, or using an unpublished
# Obtain nextstrain.org datasets to view locally (optional)
npm run get-data
Updating Auspice should only require pulling the new version from GitHub it shouldnt require any ``npm`` commands. You will, however, have to re-build Auspice whenever the client-related code has changed, via ``auspice build``.
Updating Auspice should only require pulling the new version from GitHub - it shouldn't require any ``npm`` commands. You will, however, have to re-build Auspice whenever the client-related code has changed, via ``auspice build``.

0 comments on commit fbd661c

Please sign in to comment.