JuliaDynamics / JuliaDynamics/NonlinearDynamicsTextbook
Add note on "creating a dynamical system in DynamicalSystems.jl" for high dimensional systems
Nobody has claimed this yet.
- Dominant language
- Julia
- Stars
- 266
- Forks
- 24
- PR merge metrics
- No merged PRs in 30d
Description
It came to my attention that some students read our Chapter 1 and the use the very first code snippet to make their own dynamical system. That is great if the system is sufficiently low dimensional. However, some students use the same code to make any dynamical system, such as e.g., a coupled oscillator network which could be arbitrarily high dimensional.
We should have a clear note in that section warning about this. Something like:
Note that Code 1.1 is meant to be used when the dynamical system is low dimensional. For high dimensional systems an alternative code should be used that is described in the documentation of DynamicalSystems.jl
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open Chapter 1 and locate the first dynamical-system code snippet, identified as Code 1.1. Add a clear note there that it is intended for low-dimensional systems and that high-dimensional systems should use the alternative approach described in the DynamicalSystems.jl documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- julia
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100