aikal

Algorithms I Know and Love

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

# 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:

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

or from conda

$ conda install -c JoshZastrow aikal

or from pypi

$ pip install aikal

Documentation

Documentation can be found hosted on this GitHub repository’s pages. Additionally you can find package manager specific guidelines on conda and pypi respectively.

How to use

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

1+1