From 1fcfb347683e05f793c1535392dbb9b8e0c7e89b Mon Sep 17 00:00:00 2001 From: Will Barnes Date: Wed, 12 Sep 2018 01:36:24 -0500 Subject: [PATCH] better install instructions --- README.md | 8 +++++++- docs/index.md | 13 ++++++------- 2 files changed, 13 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 420b6ec..0b422a6 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,13 @@ hissw depends on the following Python packages, * [Jinja2](http://jinja.pocoo.org/docs/dev/) * [scipy](https://docs.scipy.org/doc/) -The best way to install these is with [conda](https://www.anaconda.com/download/). You'll also need a local install of IDL and the [Solarsoft library](http://www.lmsal.com/solarsoft/). Then, install hissw from GitHub, +The best way to install these is with [conda](https://www.anaconda.com/download/) or from PyPI, i.e. `pip install `. You'll also need a local install of IDL and the [Solarsoft library](http://www.lmsal.com/solarsoft/). To install hissw, + +```shell +$ pip install hissw +``` + +which will automatically install the package and its dependencies. Alternatively, you can install hissw from GitHub, ```shell $ git clone https://github.com/wtbarnes/hissw.git diff --git a/docs/index.md b/docs/index.md index a734c78..97ef974 100644 --- a/docs/index.md +++ b/docs/index.md @@ -6,19 +6,18 @@ The [SolarSoftware](http://www.lmsal.com/solarsoft/) (SSW) stack contains nearly ## Install and Configuration -Install the dependencies with `conda` (preferred) or `pip`, +hissw has two dependcies, -```shell -$ conda install jinja2 scipy -``` +1. `jinja2` a powerful templating engine +2. `scipy` standard scientific tools for Python -and then install this package from GitHub via `pip`, +To install hissw and its dependencies, ```shell -$ pip install git+git://github.com/wtbarnes/hissw.git +$ pip install hissw ``` -Alternatively, you can download and install the source yourself, +You can also install the above dependencies with [`conda`](https://www.anaconda.com/download/). Alternatively, you can download and install the source yourself, ```shell $ git clone https://github.com/wtbarnes/hissw.git