Skip to content

Commit e2d1c5f

Browse files
authored
Update README.md
1 parent d84aba7 commit e2d1c5f

File tree

1 file changed

+3
-32
lines changed

1 file changed

+3
-32
lines changed

README.md

Lines changed: 3 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -4,37 +4,15 @@
44
<img width="30%" src="images/logo.png" alt="ODE Test Problems" title="ODE Test Problems">
55
</p>
66

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

8+
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>
109

11-
12-
13-
14-
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>
15-
16-
17-
![Version](https://img.shields.io/github/v/release/ComputationalScienceLaboratory/ODE-Test-Problems?label=Version)
18-
![GitHub](https://img.shields.io/github/license/ComputationalScienceLaboratory/ODE-Test-Problems)
1910

2011
[![Version](https://img.shields.io/github/v/release/ComputationalScienceLaboratory/ODE-Test-Problems?label=Version)](https://github.com/ComputationalScienceLaboratory/ODE-Test-Problems/releases)
2112
[![License](https://img.shields.io/github/license/ComputationalScienceLaboratory/ODE-Test-Problems?label=License)](https://github.com/ComputationalScienceLaboratory/ODE-Test-Problems/blob/master/license.txt)
22-
2313
[![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)
2414
[![Documentation](https://github.com/ComputationalScienceLaboratory/ODE-Test-Problems/actions/workflows/documentation.yml/badge.svg)](https://computationalsciencelaboratory.github.io/ODE-Test-Problems/)
2515

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

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

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

10078
## Further Reading
10179

102-
`ODE Test Problems` documentation is maintained on [this page](https://computationalsciencelaboratory.github.io/ODE-Test-Problems).
103-
104-
New feature requests, and bug reports can be made through
80+
`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
10581
[GitHub issues](https://github.com/ComputationalScienceLaboratory/ODE-Test-Problems/issues).
10682
We also accept pull requests that adhere to our
107-
[contributing guide](docs/contrib.rst).
108-
109-
110-
An interactive tutorial on the main features of `OTP` is available in a Jupyter notebook [in the repository](/notebooks)
111-
112-
Further discussion of the main contributions of this open-source package can be found in our [paper](/paper/paper.md).
83+
[contributing guide](docs/contrib.rst). An interactive tutorial on the main features of `OTP` is available in a Jupyter notebook [in the repository](/notebooks).
11384

11485

0 commit comments

Comments
 (0)