# aikal


<!-- 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 aikal in Development mode

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

# make changes under nbs/ directory
# ...

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

## Usage

### Installation

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

``` sh
$ pip install git+https://github.com/JoshZastrow/aikal.git
```

or from [conda](https://anaconda.org/JoshZastrow/aikal)

``` sh
$ conda install -c JoshZastrow aikal
```

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

``` sh
$ pip install aikal
```

### Documentation

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

## How to use

Fill me in please! Don’t forget code examples:

``` python
1+1
```

    2