Skip to content

Commit

Permalink
updated readme and version
Browse files Browse the repository at this point in the history
  • Loading branch information
jrenaud90 committed Mar 29, 2023
1 parent 43b9d7b commit 29ce361
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 12 deletions.
20 changes: 10 additions & 10 deletions Benchmarks/CyRK - SciPy Comparison.ipynb

Large diffs are not rendered by default.

Binary file added Benchmarks/CyRK_SciPy_Compare_v0-5-0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Currently, CyRK's [numba](https://numba.discourse.group/) (njit-safe) implementa
The [cython](https://cython.org/) implementation is 5-30x faster. The cython function is also largely pre-compiled which avoids most of the
initial performance hit found with using the numba version.

<img style="text-align: center" src="https://github.com/jrenaud90/CyRK/blob/main/Benchmarks/CyRK_SciPy_Compare_v0-4-0a0-dev7.png" alt="CyRK Performance" />
<img style="text-align: center" src="https://github.com/jrenaud90/CyRK/blob/main/Benchmarks/CyRK_SciPy_Compare_v0-5-0.png" alt="CyRK Performance" />

## Installation

Expand Down Expand Up @@ -149,6 +149,8 @@ The solver will then interpolate the results to fit this array.

### Limitations and Known Issues

See all [issues here](https://github.com/jrenaud90/CyRK/issues).

- [Issue 1](https://github.com/jrenaud90/CyRK/issues/1): Absolute tolerance can only be passed as a single value
(same for all y's).

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name='CyRK'
version = '0.5.0b0'
version = '0.5.0'
description='Runge-Kutta ODE Integrator Implemented in Cython and Numba.'
authors= [
{name = 'Joe P. Renaud', email = '[email protected]'}
Expand Down

0 comments on commit 29ce361

Please sign in to comment.