|
4 | 4 | [](https://travis-ci.org/JuliaDiffEq/ParameterizedFunctions.jl) [](https://ci.appveyor.com/project/ChrisRackauckas/parameterizedfunctions-jl) |
5 | 5 | [](https://codecov.io/gh/JuliaDiffEq/ParameterizedFunctions.jl) |
6 | 6 |
|
7 | | - |
8 | | -## Note that this library is deprecated in favor of [ModelingToolkit.jl](https://github.com/JuliaDiffEq/ModelingToolkit.jl). ParameterizedFunctions.jl will continue to work but is in maitanance mode. |
9 | | - |
10 | | -ParameterizedFunctions.jl is a component of the JuliaDiffEq ecosystem which allows |
11 | | -for parameters to be explicitly present within functions. The interface which |
12 | | -ParameterizedFunctions describes allows for functionality which requires parameters, |
13 | | -such as parameter sensitivity analysis and parameter estimation, to be added to |
14 | | -the differential equation solvers of [DifferentialEquations.jl](https://github.com/JuliaDiffEq/DifferentialEquations.jl). |
15 | | -While the interface itself is of importance to ecosystem developers, |
16 | | -ParameterizedFunctions.jl provides user-facing macros which make a |
17 | | -`ParameterizedFunction` easy to define, and automatically |
18 | | -include optimizations like explicit Jacobian functions and explicit inverse Jacobian |
19 | | -functions for the differential equation solvers to take advantage of. The result |
20 | | -is an easy to use API which allows for more functionality and more performance |
21 | | -optimizations than could traditionally be offered. |
22 | | - |
23 | | -test |
24 | | - |
25 | | -## The Basic Idea |
26 | | - |
27 | | -`ParameterizedFunction` is a type which can be used in various JuliaDiffEq solvers where |
28 | | -the parameters must be accessible by the solver function. These use call overloading |
29 | | -generate a type which acts like a function `f(t,u,du)` but has access to many more |
30 | | -features. For example, a `ParameterizedFunction` can contain a function for the Jacobian |
31 | | -or Inverse Jacobian. If such functions exist, the solvers can use them to increase |
32 | | -the speed of computations. If they don't exist, the solvers will ignore them. Since |
33 | | -`ParameterizedFunction` is a subtype of `Function`, these can be used anywhere that |
34 | | -a function can be used, just with the extra functionality ignored. |
| 7 | +ParameterizedFunctions.jl is a component of the SciML ecosystem which allows |
| 8 | +for easily defining parameterized ODE models in a simple syntax. |
35 | 9 |
|
36 | 10 | ## Basic Usage |
37 | 11 |
|
|
0 commit comments