YT(1)

✨ yt — bestie's guide to the command line 💖

okay so you know how yt is that whole python thing for looking at astrophysical data?? well this is the version of it you can run straight from your terminal, no python interpreter required, no import statements, no waiting. it's giving convenience ✨

🌸 NAME 🌸

yt — a command-line tool that lets you access some of yt's basic functionality without opening a python interpreter. periodt. 💅

🎀 DESCRIPTION 🎀

so basically this tool is a whole collection of subcommands. like a little friend group of them. and they can do a bunch of stuff for you, lowkey fast: make plots of slices and projections through a dataset, update yt's codebase, print basic statistics about a dataset, launch an IPython notebook session, and more. more!! 🦋

here's the usage line, verbatim, don't @ me:

yt [-h] [--config CONFIG] [--paste] [--paste-detailed]
[--detailed] [--rpdb] [--parallel] [--version] subcommand

yt command line arguments 🌈

⭐ optional arguments ⭐

these are the flags you can sprinkle on top, iykyk:

• -h, --help — shows this help message and dips out. iconic behaviour honestly.
• --config CONFIG — sets a configuration option, and it has to be in the form param=value.
• --paste — pastes that traceback over to paste.yt-project.org 🫶
• --paste-detailed — pastes a detailed traceback, local variables and all, to paste.yt-project.org. we're getting the whole story.
• --detailed — displays a detailed traceback.
• --rpdb — enables remote pdb interaction (this one's for parallel debugging).
• --parallel — runs in MPI-parallel mode. and heads up bestie: it must be launched as an MPI task.
• --version — shows the program's version number and exits. short and sweet.

👑 subcommands 👑

the main characters. one per bullet, all of them, no skips:

• help — prints the help message.
• bugreport — reports a bug in yt. (they want to hear it!!)
• hub_register — registers a user on the Hub: https://hub.yt-project.org/
• instinfo — gets some information about the yt installation.
• version — gets some information about the yt installation. yes, same description as instinfo, that's just how it is 💀
• load — loads a single dataset into an IPython instance.
• mapserver — serves a plot in a GMaps-style interface. 🗺️
• pastebin — posts a script to an anonymous pastebin.
• pastebin_grab — prints an online pastebin to STDOUT so you can use it locally.
• upload_notebook — uploads an IPython notebook to hub.yt-project.org.
• plot — creates a set of images. 🎨
• rpdb — connects to a currently running (on localhost) rpd session. commands run with --rpdb will trigger an rpdb session with any uncaught exceptions.
• notebook — runs the IPython Notebook.
• stats — prints stats and the max/min value of a given field (if you asked for one), for one or more datasets. the default field is density. 🌌
• update — updates the yt installation to the most recent version. glow up time ✨
• upload_image — uploads an image to imgur.com. must be PNG. that's the rule, no exceptions.

💜 AUTHORS 💜

yt was primarily written by the yt Development Team. shoutout to them fr fr 🫶

🌈 SEE ALSO 🌈

full documentation for the yt commandline can be found at https://yt-project.org/doc/ — go read it, it's a whole vibe 📖

okay that's the whole page!! this was yt version 3.2.3-1, dated August 2015, living its best life as part of User Commands. mwah, take care of her 💖🎀🦋