Skip to content

Commit

Permalink
updated setup.py with python requires
Browse files Browse the repository at this point in the history
  • Loading branch information
Nicholaswogan committed Jul 27, 2021
1 parent a6dcba8 commit a415add
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,10 @@
This package is very similar to `scipy.integrate.solve_ivp` ([see here](https://docs.scipy.org/doc/scipy/reference/generated/scipy.integrate.solve_ivp.html)), when you set `method = 'LSODA'`. But, `scipy.integrate.solve_ivp` invokes the python interpreter every time step which can be slow. Also, `scipy.integrate.solve_ivp` can not be used within numba jit-compiled python functions. In contrast, `NumbaLSODA` never invokes the python interpreter during integration and can be used within a numba compiled function which makes `NumbaLSODA` a lot faster than scipy for most problems (see `benchmark` folder).

## Installation
`NumbaLSODA` will probably only work on MacOS or Linux. You must have `CMake` and a C++ compiler. You must also have python >3.6.0 with `numpy` and `numba`.

After satisfying the dependencies, install with the pip command below
`NumbaLSODA` will only work on MacOS or Linux. Install with pip:

```
python -m pip install git+git://github.com/Nicholaswogan/NumbaLSODA.git
python -m pip install NumbaLSODA
```

## Basic usage
Expand Down
4 changes: 3 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
setup(
name="NumbaLSODA",
packages=['NumbaLSODA'],
version='0.1.0',
version='0.1.3',
license='MIT',
install_requires=['numpy','numba'],
author = 'Nicholas Wogan',
Expand All @@ -17,5 +17,7 @@
' which can be called from within numba functions.',
long_description=long_description,
long_description_content_type='text/markdown',
python_requires='>3.6',
url = "https://github.com/Nicholaswogan/NumbaLSODA",
cmake_args=['-DSKBUILD=ON']
)

0 comments on commit a415add

Please sign in to comment.