ts-scikit/README.md

A scientific toolkit written in Typescript

# ts-scikit [![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coveralls Status][coveralls-image]][coveralls-url] [![Gitter chat][gitter-image]][gitter-url]

> A scientific library written in Typescript.

This module contains a library of functions and objects to be used for scientific computing, digital signal analysis, mathematics and graphics.

<!-- Run `npm run toc` to update below section -->
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->


- [Install](#install)
- [Where can I find help?](#where-can-i-find-help)
- [Modules](#modules)
  - [dsp](#dsp)
  - [maths](#maths)
  - [utils](#utils)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## Install

Install with [npm](https://www.npmjs.com/get-npm)

```shell script
npm install ts-scikit 
```

## Where can I find help?

[![Gitter chat][gitter-image]][gitter-url]

## Modules

This library is broken out into separate modules:

| Module | Description |
|   ---: | :---        |
|  dsp   | Useful for digital signal processing |
| maths  | Mathematical objects and their relationships |
| utils  | Helpful functions and processes |


[downloads-image]: http://img.shields.io/npm/dt/ts-scikit.svg
[npm-url]: https://npmjs.org/package/ts-scikit
[npm-image]: http://img.shields.io/npm/v/ts-scikit.svg

[travis-url]: https://travis-ci.org/chrisengelsma/ts-scikit
[travis-image]: http://img.shields.io/travis/chrisengelsma/ts-scikit.svg

[gitter-url]: https://gitter.im/chrisengelsma/ts-scikit
[gitter-image]: https://badges.gitter.im/chrisengelsma/ts-scikit.png

[coveralls-url]: https://img.shields.io/coveralls/github/chrisengelsma/ts-scikit/master
[coveralls-image]: http://img.shields.io/coveralls/chrisengelsma/ts-scikit/master.svg