# haruspex


<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->

This file will become your README and also the index of your
documentation.

## Developer Guide

If you are new to using `nbdev` here are some useful pointers to get you
started.

### Install haruspex in Development mode

``` sh
# make sure haruspex package is installed in development mode
$ pip install -e .

# make changes under nbs/ directory
# ...

# compile to have changes apply to haruspex
$ nbdev_prepare
```

## Usage

### Installation

Install latest from the GitHub
[repository](https://github.com/redam94/haruspex):

``` sh
$ pip install git+https://github.com/redam94/haruspex.git
```

or from [conda](https://anaconda.org/redam94/haruspex)

``` sh
$ conda install -c redam94 haruspex
```

or from [pypi](https://pypi.org/project/haruspex/)

``` sh
$ pip install haruspex
```

### Documentation

Documentation can be found hosted on this GitHub
[repository](https://github.com/redam94/haruspex)’s
[pages](https://redam94.github.io/haruspex/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/redam94/haruspex) and
[pypi](https://pypi.org/project/haruspex/) respectively.

## How to use