Skip to content

Commit 6ff1809

Browse files
ArnoStrouwenArnoStrouwen
committed
format markdown
1 parent 2e10393 commit 6ff1809

Some content is hidden

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

53 files changed

+2063
-1880
lines changed

‎.JuliaFormatter.toml

+1
Original file line numberDiff line numberDiff line change
@@ -1 +1,2 @@
11
style = "sciml"
2+
format_markdown = true

‎CONTRIBUTING.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
- This repository follows the [SciMLStyle](https://github.com/SciML/SciMLStyle) and the SciML [ColPrac](https://github.com/SciML/ColPrac).
2-
- Please run `using JuliaFormatter, ModelingToolkit; format(joinpath(dirname(pathof(ModelingToolkit)), ".."))` before commiting.
3-
- Add tests for any new features.
1+
- This repository follows the [SciMLStyle](https://github.com/SciML/SciMLStyle) and the SciML [ColPrac](https://github.com/SciML/ColPrac).
2+
- Please run `using JuliaFormatter, ModelingToolkit; format(joinpath(dirname(pathof(ModelingToolkit)), ".."))` before commiting.
3+
- Add tests for any new features.

‎LICENSE.md

+15-22
Original file line numberDiff line numberDiff line change
@@ -2,43 +2,36 @@ The ModelingToolkit.jl package is licensed under the MIT "Expat" License:
22

33
> Copyright (c) 2018-22: Yingbo Ma, Christopher Rackauckas, Julia Computing, and
44
> contributors
5-
>
6-
>
5+
>
76
> Permission is hereby granted, free of charge, to any person obtaining a copy
8-
>
7+
>
98
> of this software and associated documentation files (the "Software"), to deal
10-
>
9+
>
1110
> in the Software without restriction, including without limitation the rights
12-
>
11+
>
1312
> to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14-
>
13+
>
1514
> copies of the Software, and to permit persons to whom the Software is
16-
>
15+
>
1716
> furnished to do so, subject to the following conditions:
18-
>
19-
>
20-
>
17+
>
2118
> The above copyright notice and this permission notice shall be included in all
22-
>
19+
>
2320
> copies or substantial portions of the Software.
24-
>
25-
>
26-
>
21+
>
2722
> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
28-
>
23+
>
2924
> IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
30-
>
25+
>
3126
> FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
32-
>
27+
>
3328
> AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
34-
>
29+
>
3530
> LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
36-
>
31+
>
3732
> OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
38-
>
33+
>
3934
> SOFTWARE.
40-
>
41-
>
4235
4336
The code in `src/structural_transformation/bipartite_tearing/modia_tearing.jl`,
4437
which is from the [Modia.jl](https://github.com/ModiaSim/Modia.jl) project, is

‎NEWS.md

+5-6
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
# ModelingToolkit v8 Release Notes
22

3-
43
### Upgrade guide
54

6-
- `connect` should not be overloaded by users anymore. `[connect = Flow]`
7-
informs ModelingToolkit that particular variable in a connector ought to sum
8-
to zero, and by default, variables are equal in a connection. Please check out
9-
[acausal components tutorial](https://docs.sciml.ai/ModelingToolkit/stable/tutorials/acausal_components/)
10-
for examples.
5+
- `connect` should not be overloaded by users anymore. `[connect = Flow]`
6+
informs ModelingToolkit that particular variable in a connector ought to sum
7+
to zero, and by default, variables are equal in a connection. Please check out
8+
[acausal components tutorial](https://docs.sciml.ai/ModelingToolkit/stable/tutorials/acausal_components/)
9+
for examples.

‎README.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,13 @@
11
# ModelingToolkit.jl
22

3-
43
[![Join the chat at https://julialang.zulipchat.com #sciml-bridged](https://img.shields.io/static/v1?label=Zulip&message=chat&color=9558b2&labelColor=389826)](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
54
[![Global Docs](https://img.shields.io/badge/docs-SciML-blue.svg)](https://docs.sciml.ai/ModelingToolkit/stable/)
65

76
[![codecov](https://codecov.io/gh/SciML/ModelingToolkit.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/SciML/ModelingToolkit.jl)
87
[![Coverage Status](https://coveralls.io/repos/github/SciML/ModelingToolkit.jl/badge.svg?branch=master)](https://coveralls.io/github/SciML/ModelingToolkit.jl?branch=master)
98
[![Build Status](https://github.com/SciML/ModelingToolkit.jl/workflows/CI/badge.svg)](https://github.com/SciML/ModelingToolkit.jl/actions?query=workflow%3ACI)
109

11-
[![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)
10+
[![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)
1211
[![SciML Code Style](https://img.shields.io/static/v1?label=code%20style&message=SciML&color=9558b2&labelColor=389826)](https://github.com/SciML/SciMLStyle)
1312

1413
ModelingToolkit.jl is a modeling framework for high-performance symbolic-numeric computation
@@ -121,7 +120,9 @@ plot(sol, idxs = (a, lorenz1.x, lorenz2.z))
121120
![](https://user-images.githubusercontent.com/17304743/187790221-528046c3-dbdb-4853-b977-799596c147f3.png)
122121

123122
# Citation
123+
124124
If you use ModelingToolkit.jl in your research, please cite [this paper](https://arxiv.org/abs/2103.05244):
125+
125126
```
126127
@misc{ma2021modelingtoolkit,
127128
title={ModelingToolkit: A Composable Graph Transformation System For Equation-Based Modeling},

‎docs/src/basics/AbstractSystem.md

+31-30
Original file line numberDiff line numberDiff line change
@@ -10,28 +10,29 @@ model manipulation and compilation.
1010
### Subtypes
1111

1212
There are three immediate subtypes of `AbstractSystem`, classified by how many independent variables each type has:
13-
* `AbstractTimeIndependentSystem`: has no independent variable (e.g.: `NonlinearSystem`)
14-
* `AbstractTimeDependentSystem`: has a single independent variable (e.g.: `ODESystem`)
15-
* `AbstractMultivariateSystem`: may have multiple independent variables (e.g.: `PDESystem`)
13+
14+
- `AbstractTimeIndependentSystem`: has no independent variable (e.g.: `NonlinearSystem`)
15+
- `AbstractTimeDependentSystem`: has a single independent variable (e.g.: `ODESystem`)
16+
- `AbstractMultivariateSystem`: may have multiple independent variables (e.g.: `PDESystem`)
1617

1718
## Constructors and Naming
1819

1920
The `AbstractSystem` interface has a consistent method for constructing systems.
2021
Generally, it follows the order of:
2122

22-
1. Equations
23-
2. Independent Variables
24-
3. Dependent Variables (or States)
25-
4. Parameters
23+
1. Equations
24+
2. Independent Variables
25+
3. Dependent Variables (or States)
26+
4. Parameters
2627

2728
All other pieces are handled via keyword arguments. `AbstractSystem`s share the
2829
same keyword arguments, which are:
2930

30-
- `system`: This is used for specifying subsystems for hierarchical modeling with
31-
reusable components. For more information, see the [components page](@ref components).
32-
- Defaults: Keyword arguments like `defaults` are used for specifying default
33-
values which are used. If a value is not given at the `SciMLProblem` construction
34-
time, its numerical value will be the default.
31+
- `system`: This is used for specifying subsystems for hierarchical modeling with
32+
reusable components. For more information, see the [components page](@ref components).
33+
- Defaults: Keyword arguments like `defaults` are used for specifying default
34+
values which are used. If a value is not given at the `SciMLProblem` construction
35+
time, its numerical value will be the default.
3536

3637
## Composition and Accessor Functions
3738

@@ -43,32 +44,32 @@ total set, which includes that of all systems held inside.
4344

4445
The values which are common to all `AbstractSystem`s are:
4546

46-
- `equations(sys)`: All equations that define the system and its subsystems.
47-
- `states(sys)`: All the states in the system and its subsystems.
48-
- `parameters(sys)`: All parameters of the system and its subsystems.
49-
- `nameof(sys)`: The name of the current-level system.
50-
- `get_eqs(sys)`: Equations that define the current-level system.
51-
- `get_states(sys)`: States that are in the current-level system.
52-
- `get_ps(sys)`: Parameters that are in the current-level system.
53-
- `get_systems(sys)`: Subsystems of the current-level system.
47+
- `equations(sys)`: All equations that define the system and its subsystems.
48+
- `states(sys)`: All the states in the system and its subsystems.
49+
- `parameters(sys)`: All parameters of the system and its subsystems.
50+
- `nameof(sys)`: The name of the current-level system.
51+
- `get_eqs(sys)`: Equations that define the current-level system.
52+
- `get_states(sys)`: States that are in the current-level system.
53+
- `get_ps(sys)`: Parameters that are in the current-level system.
54+
- `get_systems(sys)`: Subsystems of the current-level system.
5455

5556
Optionally, a system could have:
5657

57-
- `observed(sys)`: All observed equations of the system and its subsystems.
58-
- `get_observed(sys)`: Observed equations of the current-level system.
59-
- `get_continuous_events(sys)`: `SymbolicContinuousCallback`s of the current-level system.
60-
- `get_defaults(sys)`: A `Dict` that maps variables into their default values.
61-
- `independent_variables(sys)`: The independent variables of a system.
62-
- `get_noiseeqs(sys)`: Noise equations of the current-level system.
63-
- `get_metadata(sys)`: Any metadata about the system or its origin to be used by downstream packages.
58+
- `observed(sys)`: All observed equations of the system and its subsystems.
59+
- `get_observed(sys)`: Observed equations of the current-level system.
60+
- `get_continuous_events(sys)`: `SymbolicContinuousCallback`s of the current-level system.
61+
- `get_defaults(sys)`: A `Dict` that maps variables into their default values.
62+
- `independent_variables(sys)`: The independent variables of a system.
63+
- `get_noiseeqs(sys)`: Noise equations of the current-level system.
64+
- `get_metadata(sys)`: Any metadata about the system or its origin to be used by downstream packages.
6465

65-
Note that if you know a system is an `AbstractTimeDependentSystem` you could use `get_iv` to get the
66+
Note that if you know a system is an `AbstractTimeDependentSystem` you could use `get_iv` to get the
6667
unique independent variable directly, rather than using `independent_variables(sys)[1]`, which is clunky and may cause problems if `sys` is an `AbstractMultivariateSystem` because there may be more than one independent variable. `AbstractTimeIndependentSystem`s do not have a method `get_iv`, and `independent_variables(sys)` will return a size-zero result for such. For an `AbstractMultivariateSystem`, `get_ivs` is equivalent.
6768

6869
A system could also have caches:
6970

70-
- `get_jac(sys)`: The Jacobian of a system.
71-
- `get_tgrad(sys)`: The gradient with respect to time of a system.
71+
- `get_jac(sys)`: The Jacobian of a system.
72+
- `get_tgrad(sys)`: The gradient with respect to time of a system.
7273

7374
## Transformations
7475

0 commit comments

Comments
 (0)