SimpleSim
A minimalist Julia package for modular dynamical systems simulation. Work in Progress :-)
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (12.3%) to scientific vocabulary
Keywords
Repository
A minimalist Julia package for modular dynamical systems simulation. Work in Progress :-)
Basic Info
- Host: GitHub
- Owner: janneshb
- License: mit
- Language: Julia
- Default Branch: main
- Homepage: https://janneshb.github.io/SimpleSim.jl/
- Size: 17.5 MB
Statistics
- Stars: 17
- Watchers: 1
- Forks: 0
- Open Issues: 14
- Releases: 5
Topics
Metadata Files
Readme.md
SimpleSim.jl
SimpleSim.jl is a light-weight simulation package for dynamical systems simulation, controller synthesis and testing and robotics.
Run import Pkg; Pkg.add("SimpleSim") from within your Julia environment to install SimpleSim.jl.
Short Overview
The main point of interaction with SimpleSim.jl is the simulate function. As a first argument, it expects to be passed some object that provides named fields that supply hooks for various functionalities.
A simple example of a dynamical system model accepted by SimpleSim.jl would be
julia
my_model = (
fc = dynamics_function,
gc = measurement_function,
)
where we pass two functions dynamics_function and measurement_function that we have defined elsewhere.
These two functions model the dynamics of the model using the following approach for continuous-time dynamical systems
math
\dot{x}(t) = f(x(t), u(t), p, t)\\
y(t) = g(x(t), u(t), p, t)
or in Julia
julia
dynamics_function = (x, u, p, t) -> ...
measurement_function = (x, u, p, t) -> ...
If my_model has no field named p, SimpleSim.jl will pass nothing to fc and gc.
Similarly, SimpleSim.jl supports discrete-time systems
math
x_{k+1} = f(x_k, u_k, p, t)\\
y_k = g(x_k, u_k, p, t)
which are modeled as
julia
my_dt_model = (
fd = dt_dynamics_function,
gd = dt_measurement_function,
Δt = 1 // 10,
)
Running a simulation is as easy as calling simulate with your model and a total simulation time T.
julia
data = simulate(my_model, T = 10 // 1)
Examples
Multiple demos in the examples/ provide a rough but incomplete overview of what SimpleSim.jl can do.
Some examples are described in detail in the official documentation. In the future more complex examples and tutorials will be added there.
Credit
A similar simulation architecture was proposed by @tuckermcclure in overdot-sandbox.
Owner
- Name: Jannes
- Login: janneshb
- Kind: user
- Repositories: 1
- Profile: https://github.com/janneshb
Citation (CITATION.bib)
@software{SimpleSim,
author = {H{\"u}hnerbein, Jannes},
title = {{S}imple{S}im.jl: {A} minimalist {J}ulia package for modular dynamical systems simulation},
url = {https://github.com/janneshb/SimpleSim.jl},
version = {0.1.4},
year = {2024},
month = {04},
}
GitHub Events
Total
- Create event: 5
- Commit comment event: 2
- Release event: 1
- Issues event: 7
- Watch event: 11
- Delete event: 1
- Member event: 1
- Issue comment event: 5
- Push event: 24
- Pull request event: 8
Last Year
- Create event: 5
- Commit comment event: 2
- Release event: 1
- Issues event: 7
- Watch event: 11
- Delete event: 1
- Member event: 1
- Issue comment event: 5
- Push event: 24
- Pull request event: 8
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 18
- Total pull requests: 25
- Average time to close issues: 24 days
- Average time to close pull requests: about 4 hours
- Total issue authors: 2
- Total pull request authors: 1
- Average comments per issue: 0.28
- Average comments per pull request: 1.04
- Merged pull requests: 24
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 18
- Pull requests: 25
- Average time to close issues: 24 days
- Average time to close pull requests: about 4 hours
- Issue authors: 2
- Pull request authors: 1
- Average comments per issue: 0.28
- Average comments per pull request: 1.04
- Merged pull requests: 24
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- janneshb (15)
- JuliaTagBot (1)
Pull Request Authors
- janneshb (48)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- julia 1 total
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 5
juliahub.com: SimpleSim
A minimalist Julia package for modular dynamical systems simulation. Work in Progress :-)
- Homepage: https://janneshb.github.io/SimpleSim.jl/
- Documentation: https://docs.juliahub.com/General/SimpleSim/stable/
- License: MIT
-
Latest release: 0.1.4
published over 1 year ago