DRS_TOOL(1)

πŸ’– NAME πŸ’–

So bestie, welcome to drs_tool β€” the command-line interface to DRSLIB, living its best life in section 1 of the drslib() manual. It's giving "I talk to your DRS tree so you don't have to". Periodt.


✨ SYNPOPSIS ✨

Okay so this section exists in the original page and it is literally empty β€” no synopsis lines, nothing. We're not skipping it, we're just being honest that there's nothing in it. πŸ™ˆ


πŸŽ€ DESCRIPTION πŸŽ€

Also empty in the original, bestie. Not a single sentence. The real vibes live in USAGE and OPTIONS below. πŸ’…


🌸 USAGE 🌸

Here's the usage text, character for character, exactly how it shows up (yes, the line wrapping is squished in the original β€” we don't fix, we preserve):

Usage: drs_tool [command] [options] [drs-pattern]

command: list      list publication-level datasets todo      show file
operations pending for the next version upgrade   make changes to the
selected datasets to upgrade to the next version mapfile   make a
mapfile of the selected dataset history   list all versions of the
selected dataset init      initialise CMIP5 product detection data

So the commands it's throwing at you are:

  • list β€” list publication-level datasets
  • todo β€” show file operations pending for the next version upgrade
  • make β€” make changes to the selected datasets to upgrade to the next version
  • mapfile β€” make a mapfile of the selected dataset
  • history β€” list all versions of the selected dataset
  • init β€” initialise CMIP5 product detection data

That's the whole menu, no cap. πŸ“


πŸ‘‘ OPTIONS πŸ‘‘

  • --help β€” display this help message and exit
  • --version β€” output version information and exit

And then, because the original really does list them again all over, here's the full option block:

  • -h, --help β€” show this help message and exit
  • -R ROOT, --root=ROOT β€” Root directory of the DRS tree
  • -I INCOMING, --incoming=INCOMING β€” Incoming directory for DRS files. Defaults to <root>/output
  • -a ACTIVITY, --activity=ACTIVITY β€” Set DRS attribute activity for dataset discovery
  • -p PRODUCT, --product=PRODUCT β€” Set DRS attribute product for dataset discovery
  • -i INSTITUTE, --institute=INSTITUTE β€” Set DRS attribute institute for dataset discovery
  • -m MODEL, --model=MODEL β€” Set DRS attribute model for dataset discovery
  • -e EXPERIMENT, --experiment=EXPERIMENT β€” Set DRS attribute experiment for dataset discovery
  • -f FREQUENCY, --frequency=FREQUENCY β€” Set DRS attribute frequency for dataset discovery
  • -r REALM, --realm=REALM β€” Set DRS attribute realm for dataset discovery
  • -v VERSION, --version=VERSION β€” Force version upgrades to this version
  • -P FILE, --profile=FILE β€” Profile the script execution into FILE
  • --detect-product β€” Automatically detect the DRS product of incoming data
Heads up bestie: --version shows up twice in the original β€” once on its own as "output version information and exit" and once as -v VERSION, --version=VERSION where it forces version upgrades to that version. They are not the same thing. Don't get got. 😭

πŸ’œ REQUIRES πŸ’œ

Empty in the original. Nothing there. Iconic of it, honestly. ✨


πŸ¦‹ FILES πŸ¦‹

drs_tool uses metaconfig to configure and store configuration information, so its config may be found in a metaconfig.conf file β€” specifically in /etc/metaconfig/metaconfig.conf on Debian systems β€” which may be overridden by $HOME/.metaconfig.conf or ./metaconfig.conf. 🌈


🌟 ENVIRONMENT VARIABLES 🌟

The variable METACONF_CONF β€” that's it, that's the whole section as written. Short queen behaviour. πŸ‘‘


⭐ VERSION ⭐

0.3.0a3


πŸ’€ BUGS πŸ’€

To query and report bugs in drs_tool, please use reportbug on Debian systems. Fr fr, that's the official route. πŸ™


πŸ”₯ SEE ALSO πŸ”₯


🫢 AUTHOR 🫢

DRSLIB was written by Stephen Pascoe, STFC.SC.UK. This manual page was written by Alastair McKinstry. Absolute legends, both of them. πŸ’–


And that's a wrap, bestie! The footer of this page just signs off as drslib() β€” no date on it, so the only number we've got is the VERSION 0.3.0a3 up there. Go forth and slay your DRS tree. πŸŽ€βœ¨πŸ¦‹