Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@elswit
elswit authored Sep 27, 2024
1 parent d84aba7 commit e2d1c5f
Showing 1 changed file with 3 additions and 32 deletions.
35 changes: 3 additions & 32 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,37 +4,15 @@
<img width="30%" src="images/logo.png" alt="ODE Test Problems" title="ODE Test Problems">
</p>


<img src="images/logo.png" width="200" alt='ODE Test problems Logo' />

ODE Test Problems (<code>OTP</code>) is an object-oriented Matlab/Octave package offering a broad range of initial value problems in the form of ordinary and differential-algebraic equations that can be used to test numerical methods such as time integration or data assimilation. It includes problems that are linear and nonlinear, homogeneous and nonhomogeneous, autonomous and nonautonomous, scalar and high-dimensional, stiff and nonstiff, and chaotic and nonchaotic. Many are real-world problems in chemistry, astrophysics, meteorology, and electrical engineering. <code>OTP</code> also supports partitioned ODEs for testing split, multirate, and other multimethods. Functions for plotting solutions and creating movies are available for all problems, and exact solutions are included when available. <code>OTP</code> is designed for ease of use &#8212;meaning that working with and modifying problems is simple and intuitive. <code>OTP</code> is actively under development. We are currently writing full documentation in order to release version <code>1.0.0</code>. </p>




ODE Test Problems (<code>OTP</code>) is an object-oriented Matlab/Octave package offering a broad range of initial value problems in the form of ordinary and differential-algebraic equations that can be used to test numerical methods such as time integration or data assimilation. It includes problems that are linear and nonlinear, homogeneous and nonhomogeneous, autonomous and nonautonomous, scalar and high-dimensional, stiff and nonstiff, and chaotic and nonchaotic. Many are real-world problems in fields such as chemistry, astrophysics, meteorology, and electrical engineering. <code>OTP</code> also supports partitioned ODEs for testing split, multirate, and other multimethods. Functions for plotting solutions and creating movies are available for all problems, and exact solutions are included when available. <code>OTP</code> is designed for ease of use &#8212;meaning that working with and modifying problems is simple and intuitive. <code>OTP</code> is actively under development. We are currently writing full documentation in order to release version <code>1.0.0</code>. </p>


![Version](https://img.shields.io/github/v/release/ComputationalScienceLaboratory/ODE-Test-Problems?label=Version)
![GitHub](https://img.shields.io/github/license/ComputationalScienceLaboratory/ODE-Test-Problems)

[![Version](https://img.shields.io/github/v/release/ComputationalScienceLaboratory/ODE-Test-Problems?label=Version)](https://github.com/ComputationalScienceLaboratory/ODE-Test-Problems/releases)
[![License](https://img.shields.io/github/license/ComputationalScienceLaboratory/ODE-Test-Problems?label=License)](https://github.com/ComputationalScienceLaboratory/ODE-Test-Problems/blob/master/license.txt)

[![Tests](https://github.com/ComputationalScienceLaboratory/ODE-Test-Problems/actions/workflows/tests.yml/badge.svg)](https://github.com/ComputationalScienceLaboratory/ODE-Test-Problems/actions/workflows/tests.yml)
[![Documentation](https://github.com/ComputationalScienceLaboratory/ODE-Test-Problems/actions/workflows/documentation.yml/badge.svg)](https://computationalsciencelaboratory.github.io/ODE-Test-Problems/)

ODE Test Problems (OTP) is an object-oriented MATLAB/Octave package offering a broad range of initial value problems in
the form of ordinary and differential-algebraic equations that can be used to test numerical methods such as time
integration or data assimilation. It includes problems that are linear and nonlinear, homogeneous and nonhomogeneous,
autonomous and nonautonomous, scalar and high-dimensional, stiff and nonstiff, and chaotic and nonchaotic. Many are
real-world problems in fields such as chemistry, astrophysics, meteorology, and electrical engineering. OTP also
supports partitioned ODEs for testing split, multirate, and other multimethods. Functions for plotting solutions and
creating movies are available for all problems, and exact solutions are included when available. OTP is designed for
ease of use meaning that working with and modifying problems is simple and intuitive.

OTP is actively under development. We are currently writing full documentation in order to release version 1.0.0



https://github.com/ComputationalScienceLaboratory/ODE-Test-Problems/assets/5168326/e5496fee-46c0-4fb0-a42b-eb2e98374b4c

Expand Down Expand Up @@ -99,16 +77,9 @@ mov = problem.movie(t, y);

## Further Reading

`ODE Test Problems` documentation is maintained on [this page](https://computationalsciencelaboratory.github.io/ODE-Test-Problems).

New feature requests, and bug reports can be made through
`ODE Test Problems` documentation is maintained on [this page](https://computationalsciencelaboratory.github.io/ODE-Test-Problems). New feature requests and bug reports can be made through
[GitHub issues](https://github.com/ComputationalScienceLaboratory/ODE-Test-Problems/issues).
We also accept pull requests that adhere to our
[contributing guide](docs/contrib.rst).


An interactive tutorial on the main features of `OTP` is available in a Jupyter notebook [in the repository](/notebooks)

Further discussion of the main contributions of this open-source package can be found in our [paper](/paper/paper.md).
[contributing guide](docs/contrib.rst). An interactive tutorial on the main features of `OTP` is available in a Jupyter notebook [in the repository](/notebooks).


0 comments on commit e2d1c5f

Please sign in to comment.