SICONOS(1)

πŸ“¦ version 4.4.0, in debian bookworm, ubuntu jammy

✨ SICONOS ✨

okay bestie, welcome to the siconos manual page β€” it lives in the General Commands Manual section, and it's about to be your new favorite thing, no cap. πŸ’–


πŸ’… NAME πŸ’…

siconos β€” Siconos C++ Compilation. that's it, that's the whole name section, but the vibe is immaculate. πŸŽ€


πŸ¦‹ SYNOPSIS πŸ¦‹

siconos [ -a ] [ --build-dir DIRECTORY ] [ --clean-build ] [ -c | --clean ] [ -D KEY [=VALUE] ] [ -g ] [ -h | --help ] [ -j JOBS ] [ -L DIRECTORY ] [ -l LIBRARY ] [ --noexec ] [ --nocomp ] [ --opt C++ COMPILER OPTION ] [ --ldopt LINKER OPTION ] [ -P PREFIX COMMAND ] [ --plugin-dir PLUGIN DIRECTORY ] [ --plugins-dir PLUGINS DIRECTORY ] [ --src-dir SOURCES DIRECTORY ] [ -v ] [ --generator Generator Name ] [ sample[.cpp|.py] ] [ arguments ]

like… look at her. so many flags. so much power. πŸ‘‘


🌸 DESCRIPTION 🌸

the siconos(1) command compiles, links and runs a Siconos C++ input file. and if that wasn't enough (it is, honestly, but she keeps going πŸ’…) she also compiles C plugins and runs a python script. multi-talented, main character energy fr fr. ✨

Siconos is a free (Apache license 🫢) software, dedicated to modeling, simulation and control of Non Smooth Dynamical Systems. iconic behavior honestly.


⭐ OPTIONS ⭐

these are the command-line options recognized by siconos(1). buckle up, there's a lot, and every single one matters πŸ’–

  • -a β€” Find and compile all sources files in sample[.cpp|.py] directory. all of them. the whole squad. 🌈
  • --build-dir DIRECTORY β€” Compile inside the specified directory. 🏠 if it's /tmp, temp directories are created.
  • --clean-build β€” Clean build directory. bye bye build artifacts πŸ‘‹
  • -c | --clean β€” Clean the current directory (deletes binary files, etc.). 🧹 it's giving spring cleaning.
  • -D KEY [=VALUE] β€” Define a cmake and a cpp variable. define your truth bestie ✨
  • -g β€” Compile with debug information. πŸ› your future self says thank you.
  • -h | --help β€” Print help. when in doubt, ask for help, no shame πŸ’œ
  • -j JOBS NUMBER β€” Do parallel compilation with JOBS NUMBER jobs. multitasking queen πŸ’…
  • -L DIRECTORY β€” Add a directory to the linker search list. πŸ”
  • -l LIBRARY β€” Link with a library. 🀝
  • --noexec β€” Do not run executable after compilation. compile only, no encore 🎀
  • --nocomp β€” Do not compile executable before run. just run it, we ball πŸƒ
  • -O N β€” set compiler optimization. N is the number, and N is the vibe. πŸ”₯
  • --opt COMPILER OPTION β€” Add option to compiler. πŸ› οΈ
  • --ldopt LINKER OPTION β€” Add option to linker. πŸ› οΈ
  • -P PREFIX COMMAND β€” Run a prefix command (time, valgrind, gdb, etc.). put something in front of your run like a little entourage 🫢
  • --plugin-dir PLUGIN DIRECTORY β€” Compile a plugin with the sources under the specified plugin directory. the name of the compiled plugin is the name of the directory. the default is a directory named plugin. πŸ“
  • --plugins-dir PLUGINS DIRECTORY β€” For each source file under the specified directory, compile a plugin. the default is a directory named plugins. πŸ“πŸ“
  • --src-dir SOURCES DIRECTORY β€” add all source files under the specified directory to the compilation of the executable. ✨
  • -v β€” Print make(1) commands as they are executed. so you can watch the whole thing go down in real time πŸ‘€
  • --generator Generator Name β€” set the generator for cmake (the default is platform dependent, but usually "Unix Makefiles" under *nix and MacOs). this is mainly useful for Windows users. πŸͺŸ

πŸŽ€ EXAMPLES πŸŽ€

one (1) example, and she ate:

siconos -gv -P "time --format '%U'" BouncingBallTS.cpp

πŸ”₯ SEE ALSO πŸ”₯


and that's the page bestie!! πŸ’– this was SICONOS(1) from the General Commands Manual β€” that's the source/manual it ships under, and the footer is just the same name right back at you, SICONOS(1). go compile something cute. slay. πŸ‘‘βœ¨πŸ¦‹

πŸ“¦ where this page comes from