SICONOS_RUN(1)

💖 SICONOS_RUN(1) 💖

User Commands — siconos_run

okay bestie, welcome to the manual page for siconos_run, the little command that lives over in section 1 of the manual (that's the "user commands" girlies 💅). let's get into it ✨

---

🌸 NAME 🌸

siconos_run — run a pre-generated Siconos mechanics-IO HDF5 simulation file. that's it, that's the job 🫶

---

🦋 DESCRIPTION 🦋

here's the whole vibe, usage first:

usage: siconos_run [-h] [-T time] [-p period] [-e interval] [-f Hz] [-V]

       filename

Description: run a pre-generated Siconos mechanics-IO HDF5 simulation file. lowkey iconic, no notes 💅

✨ positional arguments: ✨

• filename — the simulation file (HDF5). yeah she takes a file, that's the whole point 🎀

👑 options: 👑

• -h, --help — show this help message and exit. classic. the "help me bestie" button 🌈
• -T time — time in seconds to run until (default T=1 second). so like, run until time, periodt ⏰
• -p period, --period period — time in seconds between frames (default p=5e-3). frame pacing, she's precise 🎬
• -e interval, --every interval — output every nth frame (default =1). so if you want every 3rd frame, you say 3, iykyk ✨
• -f Hz, --frequency Hz — alternative to -p, specify simulation frequency in Hz (default 200 Hz). two ways to say the same thing, pick your fighter 🦋
• -V, --version — show program's version number and exit. just the numbers, no small talk 💜

---

This script only provides a basic interface for the most common simulation options. so if you need something more complex — or you wanna specify behaviour such as controllers — you must create a custom simulation script. that's the rule, bestie, no cap 🙈

If a partially-completed simulation is found, it will be continued from the last time step until T. so like, she picks up right where she left off and keeps going to the finish line 🏃♀️💨

not me pointing out that most example scripts do not use this program at all — they simply define and then run the simulation in the same script. so yeah, siconos_run is the shortcut girlie, not the only way to live 💀

---

🎀 SEE ALSO 🎀

• The Siconos Software Documentation 📚
• http://siconos.gforge.inria.fr 🌐

---

siconos_run version 4.5.0, January 2023 — that's the whole page, bestie, you ate 💅✨💖🦋🎀👑