Skip to content

Commit

Permalink
Merge pull request #194 from aragilar/more-docs
Browse files Browse the repository at this point in the history
More docs cleanup around import paths
  • Loading branch information
aragilar authored Dec 15, 2024
2 parents b3f361b + 173f119 commit 198313c
Show file tree
Hide file tree
Showing 14 changed files with 22 additions and 22 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ A simple example solving the Van der Pol oscillator is as follows:
```python
import matplotlib.pyplot as plt
import numpy as np
from scikits.odes import ode
from scikits_odes import ode

t0, y0 = 1, np.array([0.5, 0.5]) # initial condition
def van_der_pol(t, y, ydot):
Expand Down
2 changes: 1 addition & 1 deletion apidocs/dae.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
DAE Solvers
-----------------------------

.. autoclass:: scikits.odes.dae.dae
.. autoclass:: scikits_odes.dae.dae
:members:
10 changes: 5 additions & 5 deletions apidocs/ode.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
ODE Solvers
-----------
:py:mod:`scikits.odes` contains two main routines for solving ODEs: the simpler
:py:func:`scikits.odes.odeint.odeint`, and the more configurable
:py:class:`scikits.odes.ode.ode`. Both these routines allow selection of the
:py:mod:`scikits_odes` contains two main routines for solving ODEs: the simpler
:py:func:`scikits_odes.odeint.odeint`, and the more configurable
:py:class:`scikits_odes.ode.ode`. Both these routines allow selection of the
solver and solution method used. Additionally, it is also possible to directly
use the low level interface to individual solvers.

.. autofunction:: scikits.odes.odeint.odeint
.. autofunction:: scikits_odes.odeint.odeint

.. autoclass:: scikits.odes.ode.ode
.. autoclass:: scikits_odes.ode.ode
:members:
2 changes: 1 addition & 1 deletion apidocs/sundials.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ a variable called
:py:mod:`scikits_odes_sundials` (other modules may have :py:const:`DTYPE`
defined, but :py:mod:`scikits_odes_sundials` should be preferred). Additionally
:py:const:`scikits_odes_sundials.precision` contains the precision setting found
by scikits.odes.
by scikits-odes.

To use :py:const:`DTYPE`, treat it as a numpy dtype; use it whenever you need to
create an array::
Expand Down
2 changes: 1 addition & 1 deletion packages/scikits-odes-core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ A simple example solving the Van der Pol oscillator is as follows:
```python
import matplotlib.pyplot as plt
import numpy as np
from scikits.odes import ode
from scikits_odes import ode

t0, y0 = 1, np.array([0.5, 0.5]) # initial condition
def van_der_pol(t, y, ydot):
Expand Down
2 changes: 1 addition & 1 deletion packages/scikits-odes-core/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ requires = ["setuptools"]
[project]
name = 'scikits-odes-core'
dynamic = ["version"]
description = 'Core support module for scikits.odes'
description = 'Core support module for scikits-odes'
readme = "README.md"
authors = [
{name = 'B. Malengier', email = 'benny.malengier@gmail.org'},
Expand Down
2 changes: 1 addition & 1 deletion packages/scikits-odes-daepack/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ A simple example solving the Van der Pol oscillator is as follows:
```python
import matplotlib.pyplot as plt
import numpy as np
from scikits.odes import ode
from scikits_odes import ode

t0, y0 = 1, np.array([0.5, 0.5]) # initial condition
def van_der_pol(t, y, ydot):
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
G(t,y,y') = 0 , using a combination of Backward Differentiation Formula
(BDF) methods and a choice of two linear system solution methods: direct
(dense or band) or Krylov (iterative).
Krylov is not supported from within scikits.odes.
Krylov is not supported from within scikits_odes.
In order to support it, a new interface should be created ddaspk_krylov,
with a different signature, reflecting the changes needed.
Expand Down
2 changes: 1 addition & 1 deletion packages/scikits-odes-sundials/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ A simple example solving the Van der Pol oscillator is as follows:
```python
import matplotlib.pyplot as plt
import numpy as np
from scikits.odes import ode
from scikits_odes import ode

t0, y0 = 1, np.array([0.5, 0.5]) # initial condition
def van_der_pol(t, y, ydot):
Expand Down
2 changes: 1 addition & 1 deletion packages/scikits-odes-sundials/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ requires = ["setuptools", "numpy", "cython", "pkgconfig"]
[project]
name = 'scikits-odes-sundials'
dynamic = ["version"]
description = 'Sundials wrapper module for scikits.odes'
description = 'Sundials wrapper module for scikits-odes'
readme = "README.md"
authors = [
{name = 'B. Malengier', email = 'benny.malengier@gmail.org'},
Expand Down
2 changes: 1 addition & 1 deletion packages/scikits-odes/src/scikits/odes/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
"""
scikits.odes is a scikit offering a cython wrapper around some extra ode/dae
scikits_odes is a scikit offering a cython wrapper around some extra ode/dae
solvers, so they can mature outside of scipy.
It offers wrappers around the following solvers from `SUNDIALS`_
Expand Down
2 changes: 1 addition & 1 deletion packages/scikits-odes/src/scikits_odes/dae.py
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ class dae(object):
... # we create residual equations for the problem
... result[0] = m*xdot[1] + k*x[0]
... result[1] = xdot[0] - x[1]
>>> from scikits.odes import dae
>>> from scikits_odes import dae
>>> solver = dae('ida', reseqn)
>>> result = solver.solve([0., 1., 2.], initx, initxp)
"""
Expand Down
6 changes: 3 additions & 3 deletions packages/scikits-odes/src/scikits_odes/ode.py
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ class ode(object):
The solver to use.
``'cvode'`` selects the CVODE solver from the SUNDIALS package.
See py:class:`scikits.odes.sundials.cvode.CVODE` for solver specific
See py:class:`scikits_odes_sundials.cvode.CVODE` for solver specific
options.
``'dopri5'`` selects the Dormand & Prince Runge-Kutta order (4)5
Expand Down Expand Up @@ -78,7 +78,7 @@ class ode(object):
See Also
--------
scikits.odes.odeint.odeint : an ODE integrator with a simpler interface
scikits_odes.odeint.odeint : an ODE integrator with a simpler interface
scipy.integrate : Methods in scipy for ODE integration
Examples
Expand All @@ -98,7 +98,7 @@ class ode(object):
xdot[0] = x[1]
xdot[1] = - k/m * x[0]
>>> from scikits.odes import ode
>>> from scikits_odes import ode
>>> solver = ode('cvode', rhseqn, old_api=False)
>>> result = solver.solve([0., 1., 2.], initx)
>>> print(' t Solution Exact')
Expand Down
6 changes: 3 additions & 3 deletions packages/scikits-odes/src/scikits_odes/odeint.py
Original file line number Diff line number Diff line change
Expand Up @@ -112,8 +112,8 @@ def odeint(rhsfun, tout, y0, method='bdf', **options):
See Also
--------
scikits.odes.ode.ode : a more object-oriented integrator
scikits.odes.dae.dae : a solver for differential-algebraic equations
scikits_odes.ode.ode : a more object-oriented integrator
scikits_odes.dae.dae : a solver for differential-algebraic equations
scipy.integrate.quad : for finding the area under a curve
Examples
Expand Down Expand Up @@ -159,7 +159,7 @@ def odeint(rhsfun, tout, y0, method='bdf', **options):
Call `odeint` to generate the solution.
>>> from scikits.odes.odeint import odeint
>>> from scikits_odes.odeint import odeint
>>> sol = odeint(pend, t, y0)
The solution is a named tuple `sol`. sol.values.y is an array with shape (101, 2).
Expand Down

0 comments on commit 198313c

Please sign in to comment.