Skip to content

Commit

Permalink
update docs more
Browse files Browse the repository at this point in the history
  • Loading branch information
isaacsas committed Sep 16, 2021
1 parent 4db9cce commit 179b58d
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
6 changes: 6 additions & 0 deletions docs/src/api/catalyst_api.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@ ReactionSystem
```

## Basic System Properties
See [The generated `ReactionSystem` and `Reaction`s](@ref) for more details

```@docs
species
speciesmap
Expand All @@ -88,6 +90,8 @@ numreactionparams
```

## ModelingToolkit-Inherited Accessor Functions
See [The generated `ReactionSystem` and `Reaction`s](@ref) for more details

- `ModelingToolkit.get_eqs(sys)`: The reactions of the system (ignores subsystems).
- `ModelingToolkit.equations(sys)`: Collects all reactions and equations from
the system and all subsystems.
Expand All @@ -96,6 +100,8 @@ numreactionparams
- `ModelingToolkit.get_ps(sys)`: The parameters of the system (ignores subsystems).
- `ModelingToolkit.parameters(sys)`: Collects all parameters from the system and all subsystems.
- `ModelingToolkit.get_iv(sys)`: The independent variable of the system, usually time.
- `ModelingToolkit.get_systems(sys)`: The sub-systems of `sys`.
- `ModelingToolkit.get_defaults(sys)`: The default values for parameters and initial conditions for `sys`.

## Basic Reaction Properties
```@docs
Expand Down
2 changes: 1 addition & 1 deletion docs/src/tutorials/generated_systems.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# The generated [`ReactionSystem`](@ref) and [`Reaction`](@ref)s
# The generated `ReactionSystem` and `Reaction`s

### [`ReactionSystem`](@ref) Accessors

Expand Down

0 comments on commit 179b58d

Please sign in to comment.