Skip to content

Commit 20c496c

Browse files
ArnoStrouwenArnoStrouwen
committed
format markdown
1 parent 557c4e2 commit 20c496c

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

59 files changed

+4743
-4540
lines changed

‎.JuliaFormatter.toml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
1-
style = "sciml"
1+
style = "sciml"
2+
format_markdown = true

‎LICENSE.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,3 @@ The DiffEqDocs.jl package is licensed under the MIT "Expat" License:
1919
> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
2020
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
2121
> SOFTWARE.
22-
>

‎README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,8 @@
55

66
[![Build status](https://badge.buildkite.com/21561431a9349125d0146aff52103e0fc26f17b390d974e8aa.svg)](https://buildkite.com/julialang/diffeqdocs-dot-jl)
77

8-
[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor's%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
8+
[![ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://img.shields.io/badge/ColPrac-Contributor%27s%20Guide-blueviolet)](https://github.com/SciML/ColPrac)
99
[![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)
1010

1111
DiffEqDocs.jl is a component package in the DifferentialEquations ecosystem. It holds [the documentation for the common user interface](http://docs.juliadiffeq.org/dev/). Users interested in using
1212
these features should check out [DifferentialEquations.jl](https://github.com/SciML/DifferentialEquations.jl).
13-

‎docs/src/api/daskr.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ DASKR.jl is not automatically included by DifferentialEquations.jl. To use this
55
algorithm, you will need to install and use the package:
66

77
```julia
8-
]add DASKR
8+
using Pkg
9+
Pkg.add("DASKR")
910
using DASKR
1011
```
1112

‎docs/src/api/sundials.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ Note that these solvers do not come by default, and thus one needs to install
55
the package before using these solvers:
66

77
```julia
8-
]add Sundials
8+
using Pkg
9+
Pkg.add("Sundials")
910
using Sundials
1011
```
1112

‎docs/src/basics/compatibility_chart.md

Lines changed: 47 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -7,53 +7,53 @@ the option has not been implemented, or that a given add-on has not been tested
77
with a given package. If there are any errors in this chart, please file an
88
issue or submit a pull-request.
99

10-
| Option | OrdinaryDiffEq.jl | Sundials.jl | ODE.jl | ODEInterface.jl | LSODA.jl | StochasticDiffEq.jl | DelayDiffEq.jl | DASKR.jl | DASSL.jl
11-
|----------------------------------------|-------------------|-------------|--------|-----------------|----------|---------------------|----------------|----------|----------
12-
| Nonlinear Dense (continuous) output | x | x | | | | x | x | x |
13-
| Tolerance control | x | x | x | x | x | x | x | x | x
14-
| Advanced stepsize control | x | 0 | | x | 0 | x | x | 0 |
15-
| Mass Matrices^ | x | 0 | | x | 0 | x | x | 0 |
16-
| Analytical Jacobians^† | x | x | | x | | x | x | x |
17-
| General Performance Overloads^† | x | 0 | | 0 | 0 | x | x | 0 |
18-
| internalnorm | x | 0 | x | 0 | 0 | x | x | 0 |
19-
| Initial dt | x | x | x | x | | x | x | x |
20-
| save_everystep | x | x | x | x | x | x | x | x |
21-
| saveat | x | x | x | x | x | x | x | x |
22-
| tstops | x | x | | 0 | | x | x | x |
23-
| d_discontinuities | x | | | 0 | | x | x | |
24-
| isoutofdomain | x | | x | | | x | x | |
25-
| Allows reverse time direction | x | x | x | x | x | x | x | |
26-
| Unitful numbers | x | 0 | | 0 | 0 | | x | 0 |
27-
| Arbitrary dimension arrays | x | x | x | x | x | x | x | x | x
28-
| Complex numbers | p | | | | | x | p | |
29-
| Arbitrary precision | x | 0 | x | 0 | 0 | x | x | 0 | x
30-
| ApproxFun types | x | 0 | | 0 | 0 | | x | 0 |
31-
| Progress monitoring | x | | | | | x | x | |
32-
| Integrator interface | x | x | | 0 | | x | x | |
33-
| Resizability | x | 0 | | 0 | 0 | x | x | 0 |
34-
| Cache iterator | x | 0 | | 0 | 0 | x | x | 0 |
35-
| Can choose linear solvers | x | s | | | | x | x | s | x
36-
| Can choose nonlinear solvers | x | 0 | | 0 | 0 | x | x | 0 | x
37-
| Can use out of place natively | x | 0 | x | 0 | 0 | x | x | 0 | x
38-
| Can use inplace natively | x | x | | x | x | x | x | x |
39-
| Compatible with DiffEqDevTools | x | x | x | x | x | x | x | x |
40-
| Compatible with ParameterizedFunctions | x | x | x | x | x | x | x | x |
41-
| Continuous Callbacks | x | x | | x | | x | x | | x
42-
| Discrete Callbacks | x | x | | x | | x | x | |
43-
| Monte Carlo Simulations | x | x | x | x | x | x | x | x |
44-
| Parameter Estimation | x | n | n | n | n | x | x | n | x
45-
| Parameter Sensitivity Analysis | x | x | x | x | x | | x | |
46-
| Plotting and solution handling | x | x | x | x | x | x | x | x | x
10+
| Option | OrdinaryDiffEq.jl | Sundials.jl | ODE.jl | ODEInterface.jl | LSODA.jl | StochasticDiffEq.jl | DelayDiffEq.jl | DASKR.jl | DASSL.jl |
11+
|:-------------------------------------- |:----------------- |:----------- |:------ |:--------------- |:-------- |:------------------- |:-------------- |:-------- |:-------- |
12+
| Nonlinear Dense (continuous) output | x | x | | | | x | x | x | |
13+
| Tolerance control | x | x | x | x | x | x | x | x | x |
14+
| Advanced stepsize control | x | 0 | | x | 0 | x | x | 0 | |
15+
| Mass Matrices^ | x | 0 | | x | 0 | x | x | 0 | |
16+
| Analytical Jacobians^† | x | x | | x | | x | x | x | |
17+
| General Performance Overloads^† | x | 0 | | 0 | 0 | x | x | 0 | |
18+
| internalnorm | x | 0 | x | 0 | 0 | x | x | 0 | |
19+
| Initial dt | x | x | x | x | | x | x | x | |
20+
| save_everystep | x | x | x | x | x | x | x | x | |
21+
| saveat | x | x | x | x | x | x | x | x | |
22+
| tstops | x | x | | 0 | | x | x | x | |
23+
| d_discontinuities | x | | | 0 | | x | x | | |
24+
| isoutofdomain | x | | x | | | x | x | | |
25+
| Allows reverse time direction | x | x | x | x | x | x | x | | |
26+
| Unitful numbers | x | 0 | | 0 | 0 | | x | 0 | |
27+
| Arbitrary dimension arrays | x | x | x | x | x | x | x | x | x |
28+
| Complex numbers | p | | | | | x | p | | |
29+
| Arbitrary precision | x | 0 | x | 0 | 0 | x | x | 0 | x |
30+
| ApproxFun types | x | 0 | | 0 | 0 | | x | 0 | |
31+
| Progress monitoring | x | | | | | x | x | | |
32+
| Integrator interface | x | x | | 0 | | x | x | | |
33+
| Resizability | x | 0 | | 0 | 0 | x | x | 0 | |
34+
| Cache iterator | x | 0 | | 0 | 0 | x | x | 0 | |
35+
| Can choose linear solvers | x | s | | | | x | x | s | x |
36+
| Can choose nonlinear solvers | x | 0 | | 0 | 0 | x | x | 0 | x |
37+
| Can use out of place natively | x | 0 | x | 0 | 0 | x | x | 0 | x |
38+
| Can use inplace natively | x | x | | x | x | x | x | x | |
39+
| Compatible with DiffEqDevTools | x | x | x | x | x | x | x | x | |
40+
| Compatible with ParameterizedFunctions | x | x | x | x | x | x | x | x | |
41+
| Continuous Callbacks | x | x | | x | | x | x | | x |
42+
| Discrete Callbacks | x | x | | x | | x | x | | |
43+
| Monte Carlo Simulations | x | x | x | x | x | x | x | x | |
44+
| Parameter Estimation | x | n | n | n | n | x | x | n | x |
45+
| Parameter Sensitivity Analysis | x | x | x | x | x | | x | | |
46+
| Plotting and solution handling | x | x | x | x | x | x | x | x | x |
4747

48-
* x: Full compatibility
49-
* p: Partial compatibility, only in nonstiff methods, unless the Jacobian is provided.
50-
* n: General compatibility, but not compatible with routines which
51-
require being able to autodifferentiate through the entire solver.
52-
* 0: Not possible. This is generally due to underlying inflexibility in a wrapped
53-
library.
54-
* s: Special, Sundials has its own linear solver choices.
55-
* ^: Only stiff (implicit) methods.
56-
* †: For packages with compatibility, no warning is given when a specific algorithm
57-
does not need to use this feature.
48+
- x: Full compatibility
49+
- p: Partial compatibility, only in nonstiff methods, unless the Jacobian is provided.
50+
- n: General compatibility, but not compatible with routines which
51+
require being able to autodifferentiate through the entire solver.
52+
- 0: Not possible. This is generally due to underlying inflexibility in a wrapped
53+
library.
54+
- s: Special, Sundials has its own linear solver choices.
55+
- ^: Only stiff (implicit) methods.
56+
- †: For packages with compatibility, no warning is given when a specific algorithm
57+
does not need to use this feature.
5858

5959
All blank spaces are possible future additions.

0 commit comments

Comments
 (0)