WHIRLIGIG(1)

📦 version 0.13.0, in nixos 26.05, nixpkgs unstable

🌪️ WHIRLIGIG(1) — the General Commands Manual, but make it cute

okay bestie, so this is the whirligig(1) page, and I'm gonna walk you through it like we're texting at 2am 💖

✨ NAME ✨

whirligig — find rotation series 🌈

like, it goes looking for series. that's the whole vibe.

✨ SYNOPSIS ✨

whirligig [options] input.stream

whirligig --help

🌸 DESCRIPTION 🌸

okay so whirligig takes a stream full of indexing results (think: the output of a previous indexamajig run 🫶) and goes hunting for runs of crystals — in adjacent frames — that have similar orientations and similar unit cell parameters. slay.

for every series it finds, it drops a log file, and the filename is in the form series-XX.log, where XX is a number starting from zero 🎀. that log file contains the filenames, event IDs, and crystal numbers for the frames involved. iconic.

and here's the part that's giving main character energy: the program is fully aware that the frames might not show up in the stream in chronological order (this happens when you use indexamajig -j, for example 😌), and it also knows there can be multiple crystals per frame. it handles all of that. no cap.

💅 OPTIONS 💅

  • --output-dir=foldername — puts the output log files inside foldername instead of dumping them in the working directory. ⚠️ heads up: the folder must exist before running whirligig — it will not make it for you, bestie.
  • --window-size=n — sets the size of the history buffer to n. the further apart adjacent frames can be in the input stream — like, the higher the number of parallel processes you used during indexing (see indexamajig -j) — the bigger this history buffer needs to be 🦋. whirligig will print a warning if it looks like the window is too small. just know that increasing the window size increases the amount of computation and memory required 🔥. the default is --window-size=16.

👑 AUTHOR 👑

this page was written by Thomas White. ty for your service 🫶

🎀 REPORTING BUGS 🎀

found a bug? report it to <taw@physics.org>, or go visit <http://www.desy.de/~twhite/crystfel>. do it fr fr.

Copyright © 2015-2021 Deutsches Elektronen-Synchrotron DESY, a research centre of the Helmholtz Association.

whirligig, and this manual, are part of CrystFEL.

CrystFEL is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

CrystFEL is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with CrystFEL. If not, see <http://www.gnu.org/licenses/>.

okay this part is the serious bit and I need you to take it seriously: no warranty, like, at all. the license text means what it says 💀

🦋 SEE ALSO 🦋

and that's the whole page, bestie 💜 this was the WHIRLIGIG(1) page from the General Commands Manual — the whirligig manual page, in all its glory, signed off and sealed with a 🎀. go find those rotation series 👑✨

📦 where this page comes from