Skip to content

Commit

Permalink
better install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
wtbarnes committed Sep 12, 2018
1 parent 9f56cd5 commit 1fcfb34
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 8 deletions.
8 changes: 7 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <package-name>`. 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
Expand Down
13 changes: 6 additions & 7 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 1fcfb34

Please sign in to comment.