NXSUMMARY(1)

🌸 NXSUMMARY 🌸

okay bestie, sit down, hydrate, because we're reading a whole manual page together and it's gonna be adorable. this is NXSUMMARY(1), living in section 1 of the General Commands Manual, and it's giving "tiny utility, big personality." 💅

✨ NAME ✨

nxdiff — Generate summary of a NeXus file

and yes, my love, the NAME line literally says nxdiff. we are not editing it. we report, we do not touch. 🫶

🦋 SYNOPSIS 🦋

nxsummary [--xml] [--value label] [--writeconfig config]
                [--config config] [--verbose] [--] [--version] [-h]
                [filename]

💖 DESCRIPTION 💖

so the nxsummary utility prints summary information about NeXus files. iconic behaviour, honestly. 🎀

and the way it works is that it relies heavily on a configuration file, which lives in "${HOME}/.nxsummary.conf" or /etc/nxsummary.conf. you want a sample one? you can get it with the --writeconfig flag. free config, no cap.

every item tag in that file describes a node to print from the NeXus file, okay? let's break it down:

• the path attribute — this describes where in the NeXus file to get information from. like, the address of the vibe.
• the label attribute — this is what will be printed when showing the value of the specified field. it's the name tag. the little nameplate. 🏷️
• the optional operation attribute — this lets certain operations happen on the data before printing out the result. optional, but so fun.

and the valid operations are, in order, no skipping:

• COUNT — The number of elements in the requested field.
• DIMS — The dimensions of the requested field.
• SUM — Add together all of the array elements and print the result.
• UNITS:newunits — Specify the units to print the result in.

periodt. that's the whole operation menu. 💜

👑 OPTIONS 👑

The following options are supported

• --version — Displays version information and exits. bye bestie, we love a clean exit. 🚪✨
• -h|--help — Displays usage information and exits.
• --xml — Print results as xml
• --value label — Get value of the item pointed to by the label
• --writeconfig config — Write the default configuration out to a file
• --config config — Specify configuration file
• --verbose — Turn on verbose printing
• --|--ignore_rest — Ignores the rest of the labeled arguments following this flag.

🌈 SEE ALSO 🌈

nxconvert(1), nxdir(1), nxtranslate(1), http://www.nexusformat.org

go read the friends too, they're all part of the same little universe. 🧚

🌸 AUTHOR 🌸

nxsummary was originally written by Peter Peterson <petersonpf@ornl.gov> and may be used by others.

okay and for the cute sign-off: this whole page is dated October 2011 and it's filed under NXSUMMARY(1) in the General Commands Manual. thank you for coming to my ted talk, you understood the assignment, go summarize a NeXus file. 💖✨🦋