README.md

   1 # SDDEKit
   2
   3 ![Build Status](https://travis-ci.org/maedoc/sddekit.svg?branch=master)
   4 ![Coverage Status](https://coveralls.io/repos/github/maedoc/sddekit/badge.svg?branch=master)
   5
   6 ## What is SDDEKit?
   7
   8 A library for stochastic delay differential equations implementing published
   9 numerical schemes, utilities for constructing network models and handling
  10 simulation results, as well as bindings for MATLAB, Python.  Our intent is
  11 to make it possible to use and benchmark available schemes on your favorite
  12 model, not invent new numerical schemes, so we have attempted to follow
  13 published results, documenting caveats, assumptions etc. Care will be taken to
  14 handle calculation of partial erivatives, to enable higher order schemes,
  15 optimization and inversion techniques.
  16
  17 *This is project is currently under heavy development; not for use pending v0.1 release*.
  18
  19 ## Example
  20
  21 Currently the C [header](src/sddekit.h), [tests](tests) and [benchmark](bench/bench_net_exc.c) are the best places to look.
  22
  23 You can build the tests and benchmark if you have GCC (or a C99 compiler) and Make:
  24
  25 ```
  26 make tests
  27 make bench_net_exc
  28 ```
  29
  30 ## References
  31
  32 - Kloeden & Platen 1999 *Numerical Solution of Stochastic Differential Equations*.
  33 - Fox et al 1998
  34 - Mannella 200?
  35 - Jimenez et al 2015
  36 - Kuechler & Platen 2000