SICONOS_COMPARE(1)

💖 SICONOS_COMPARE(1) 💖

okay bestie, welcome to the siconos_compare page, straight out of the User Commands corner of your manual. this is the lil tool that stares at two Siconos mechanics-IO HDF5 simulation files and goes "hmm, these are numerically… how different exactly?" 🦋

---

✨ NAME ✨

siconos_compare — numerically compare the contents of two Siconos mechanics-IO HDF5 simulation files. that's it, that's the job. 💅

---

🌸 DESCRIPTION 🌸

here's the vibe, the whole usage situation, no cap:

usage: siconos_compare [-h] [--columns <colspec>] [--start <time>]
       [--end <time>] [--interval <time>]
              [--threshold <float>] [-V] <file> <file>

Description: this icon numerically compares the contents of two Siconos mechanics-IO HDF5 simulation files. and listen — the sole output on standard output is the maximum difference between the columns you picked for comparison. one number. that's the whole vibe check. ✨

the return code situation, which honestly is the main character here:

• 0 gets returned if the maximum difference is less than the threshold
• 1 gets returned if it's greater than the threshold
• 2 gets returned if the files could not be opened or do not contain the necessary tables

🚨 and btw bestie, non-matching time indices shall be considered as failing the comparison. like, that's a fail, periodt.

🎀 positional arguments 🎀

• <file> — your input files (HDF5). yes, plural. two of them. it needs both, it's a comparison, she can't compare alone 😭

💅 options 💅

• -h, --help — show this help message and exit. the classic escape hatch, we love her 🫶
• --columns <colspec>, -c <colspec> — the list of columns to include in the comparison. they're 0-indexed, comma-separated, and may be prefixed with the table name, plus you can stack multiple lists separated by semicolon. example, since we know you want one: "dynamic:0,1,2;cf:0,1,2". the default table is "dynamic". and for what any of these columns actually mean, go read the Siconos HDF5 file format docs, iykyk 📚
• --start <time> — start time in seconds from beginning the comparison ⏰
• --end <time> — end time in seconds end the comparison ⏰
• --interval <time> — amount of time after start to compare ⏳
• --threshold <float> — threshold for comparison. this is the line between a 0 and a 1, so choose wisely bestie 🎯
• -V, --version — show program's version number and exit. she's self-aware, iconic 👑

---

🔥 SEE ALSO 🔥

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

go read the docs, they ate 💜

---

and that's a wrap!! this was siconos_compare 4.5.0, dated January 2023 — slay, bye bestie 🦋✨💖