BUMPS-WEBVIEW(1)

πŸ’– BUMPS-WEBVIEW(1) πŸ’–

okay so bestie, welcome to the bumps-webview man page β€” it lives in the User Commands section of the manual, and it's literally the webview interface situation for Bumps. buckle up πŸŽ€


✨ NAME ✨

bumps-webview β€” a webview interface for Bumps πŸ¦‹


🌸 DESCRIPTION 🌸

the vibe is: you get a whole webview interface for Bumps. here's the usage, exactly as it comes, no cap:

usage: bumps-webview [-h] [-x] [--external] [-p PORT] [--hub HUB]

[--fit {dream,scipy.leastsq,amoeba,de,lm,newton}]
       [--start] [--store STORE] [--read_store READ_STORE]
       [--write_store WRITE_STORE] [--exit] [--serializer
       {pickle,dill,dataclass}] [--trace] [--parallel PARALLEL] [--path
       PATH] [--no_auto_history] [--convergence_heartbeat]
       [--use_persistent_path] [filename]

🧚 positional arguments 🧚

  • filename β€” the problem file to load, and it's gotta be either a .py or a .json (serialized) fitproblem. that's the whole assignment bestie πŸ“

πŸŽ€ options πŸŽ€

  • -h, --help β€” shows this help message and then dips out. classic. πŸ‘‹
  • -x, --headless β€” do NOT automatically load the client in the browser. it's giving invisible mode πŸ’€
  • --external β€” listen on all interfaces, including external ones. if you don't set this flag, it's local connections only, periodt πŸ”’
  • -p, --port PORT β€” the port on which to start the server. pick your number, queen πŸ”’
  • --hub HUB β€” api address of the parent hub. this one is only used when it's called as a subprocess, iykyk πŸ›°οΈ
  • --fit {dream,scipy.leastsq,amoeba,de,lm,newton} β€” the fitting engine you wanna use. check the manual for the deets on each one πŸ”₯
  • --start β€” start the fit the moment the problem is loaded. no waiting around πŸ’…
  • --store STORE β€” sets read_store and write_store to the same file, one flag two jobs ✨
  • --read_store READ_STORE β€” read the initial session state from a file. heads up: this overrides --store πŸ“–
  • --write_store WRITE_STORE β€” output file for the session state. also overrides --store πŸ“
  • --exit β€” end the process when the fit is complete. ⚠️ but fr fr, fit results are lost unless write_store is specified. protect your data bestie 😭
  • --serializer {pickle,dill,dataclass} β€” the strategy for serializing the problem. if the store already has a value defined, it'll use that one instead πŸ«™
  • --trace β€” enable memory tracing. it prints after every uncertainty update in dream 🧠
  • --parallel PARALLEL β€” run the fit using multiprocessing for parallelism. pro tip: use --parallel=0 for all cpus, all of them, every single one 🌈
  • --path PATH β€” set the initial path for the save and load dialogs πŸ—‚οΈ
  • --no_auto_history β€” disable auto-appending problem state to history on load and at fit end. the history girlies are gonna be devastated πŸ™ˆ
  • --convergence_heartbeat β€” enable the convergence heartbeat for the jupyter kernel. it keeps the kernel alive during the fit, like a little life support 🫢
  • --use_persistent_path β€” save the most recently used path to disk so it persists between sessions. memory of a goldfish, but make it ✨persistent✨ πŸ’Ύ

πŸ¦‹ SEE ALSO πŸ¦‹

the full documentation for bumps-webview is maintained as a Texinfo manual. if the info and bumps-webview programs are properly installed at your site, then this command:

info bumps

should give you access to the complete manual. go read it, it's iconic πŸ‘‘


and that's the whole page bestie!! this was BUMPS, February 2025, signing off πŸ’œπŸ’…βœ¨ stay slay, stay serialized, and always specify your write_store πŸŽ€

πŸ“¦ where this page comes from