PYSPH_VIEWER(1)

📦 version 1.0~b2, in debian bookworm, ubuntu jammy, ubuntu noble, ubuntu stonking

🌸 PYSPH_VIEWER 🌸

okay bestie, welcome to PYSPH_VIEWER(1) — the man page for pysph_viewer, the little viewer that lets you see your results. That's it, that's the vibe. She views output. She slays. 💅

✨ NAME ✨

pysph_viewer — a viewer to view the output of results. Usage:

🦋 DESCRIPTION 🦋

Usage: pysph_viewer [-v] <trait1=value> <trait2=value> [files.npz]

So here's the tea, bestie 🫖: if you don't hand it any *.npz files, it will connect to a running solver instead. And if that doesn't happen either, it'll just display the files you gave it.

Those <trait1=value> things? They're optional settings — stuff like host, port, authkey, etc. Here's the whole roster of traits you can pass, no gatekeeping:

  • host — hostname/IP address to connect to. 📍
  • port — Port to connect to.
  • authkey — authorization key to use. 🔑
  • interval — time interval to refresh display. ⏱️
  • pause_solver — Set True/False, will pause running solver. ⏸️
  • movie_directory — directory to dump movie files (automatically set if not supplied). 🎬
  • record — True/False: record movie, i.e. store screenshots of display. 📸
  • play — True/False: Play all stored data files. ▶️
  • loop — True/False: Loop over data files. 🔁

💅 OPTIONS 💅

  • -h/--help — prints this message. classic. 🫶
  • -v — sets verbose mode which will print solver connection status failures on stdout. (so when the connection ghosted you, at least you'll know 😭)

⭐ Examples ⭐

$ pysph_viewer interval=10 host=localhost port=8900
$ pysph_viewer foo.npz
$ pysph_viewer *.npz play=True loop=True

okay so. not to be that girl, but the manpage literally repeats this next whole chunk. i'm not making it up, it's right there in the source. keeping it all because the rules are the rules, and we do not skip content in this house 💖

pysph_viewer [-v] <trait1=value> <trait2=value> [files.npz]

If *.npz files are not supplied it will connect to a running solver, if not it will display the given files.

The arguments <trait1=value> are optional settings like host, port and authkey etc. The following traits are available:

  • host — hostname/IP address to connect to. 📍
  • port — Port to connect to.
  • authkey — authorization key to use. 🔑
  • interval — time interval to refresh display. ⏱️
  • pause_solver — Set True/False, will pause running solver. ⏸️
  • movie_directory — directory to dump movie files (automatically set if not supplied). 🎬
  • record — True/False: record movie, i.e. store screenshots of display. 📸
  • play — True/False: Play all stored data files. ▶️
  • loop — True/False: Loop over data files. 🔁
  • -h/--help — prints this message. 🫶
  • -v — sets verbose mode which will print solver connection status failures on stdout.

⭐ Examples ⭐

$ pysph_viewer interval=10 host=localhost port=8900
$ pysph_viewer foo.npz
$ pysph_viewer *.npz play=True loop=True

👑 SEE ALSO 👑

The full documentation for pysph_viewer is maintained as a Texinfo manual. If the info and pysph_viewer programs are properly installed at your site, the command

info pysph_viewer

should give you access to the complete manual. go read it, it's giving ✨ thorough ✨

and that's the whole page bestie!! 🎀 this was pysph_viewer Usage: — source and version realness — dated December 2014, filed under PYSPH_VIEWER(1). mwah, go view some results 💖🌈

📦 where this page comes from