Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rreusser/ode-euler
Integrate a system of ordinary differential equations using the explicit Euler method.
https://github.com/rreusser/ode-euler
Last synced: 7 days ago
JSON representation
Integrate a system of ordinary differential equations using the explicit Euler method.
- Host: GitHub
- URL: https://github.com/rreusser/ode-euler
- Owner: rreusser
- License: mit
- Created: 2015-12-10T13:04:24.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2016-01-15T01:44:39.000Z (almost 9 years ago)
- Last Synced: 2024-10-26T12:16:25.194Z (2 months ago)
- Language: JavaScript
- Size: 12.7 KB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
ode-euler
===
[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][codecov-image]][codecov-url] [![Dependencies][dependencies-image]][dependencies-url]
> Integrate a system of ordinary differential equations using the explicit Euler method.
## Installation
``` bash
$ npm install compute-ode-euler
```
For use in the browser, use [browserify](https://github.com/substack/node-browserify).
## Usage
``` javascript
var euler = require( 'compute-ode-euler' );
```
#### euler( y0, deriv, t0, dt )
What does this function do?
## Examples
``` javascript
var euler = require( 'compute-ode-euler' );
var deriv = function(dydt, y, t) {
dydt[ 0 ] = -y[ 1 ];
dydt[ 1 ] = y[ 0 ];
}
var y0 = [1,0];
var n = 1000;
var t0 = 0;
var dt = 2.0 * Math.PI / n;
var integrator = euler( y0, deriv, t0, dt );
// Integrate 1000 steps:
integrator.steps( n );
// Integrate all the way around a circle:
// => integrator.y = [ 1.0199349143076457, -0.00008432969374211775 ]
```
To run the example code from the top-level application directory,
``` bash
$ node ./examples/index.js
```
## Tests
### Unit
Unit tests use the [Mocha](http://mochajs.org/) test framework with [Chai](http://chaijs.com) assertions. To run the tests, execute the following command in the top-level application directory:
``` bash
$ make test
```
All new feature development should have corresponding unit tests to validate correct functionality.
### Test Coverage
This repository uses [Istanbul](https://github.com/gotwarlost/istanbul) as its code coverage tool. To generate a test coverage report, execute the following command in the top-level application directory:
``` bash
$ make test-cov
```
Istanbul creates a `./reports/coverage` directory. To access an HTML version of the report,
``` bash
$ make view-cov
```
---
## License
[MIT license](http://opensource.org/licenses/MIT).
## Copyright
Copyright © 2015. The [Compute.io](https://github.com/compute-io) Authors.
[npm-image]: http://img.shields.io/npm/v/compute-ode-euler.svg
[npm-url]: https://npmjs.org/package/compute-ode-euler
[travis-image]: http://img.shields.io/travis/compute-io/ode-euler/master.svg
[travis-url]: https://travis-ci.org/compute-io/ode-euler
[codecov-image]: https://img.shields.io/codecov/c/github/compute-io/ode-euler/master.svg
[codecov-url]: https://codecov.io/github/compute-io/ode-euler?branch=master
[dependencies-image]: http://img.shields.io/david/compute-io/ode-euler.svg
[dependencies-url]: https://david-dm.org/compute-io/ode-euler
[dev-dependencies-image]: http://img.shields.io/david/dev/compute-io/ode-euler.svg
[dev-dependencies-url]: https://david-dm.org/dev/compute-io/ode-euler
[github-issues-image]: http://img.shields.io/github/issues/compute-io/ode-euler.svg
[github-issues-url]: https://github.com/compute-io/ode-euler/issues