H5COPY:(1)

πŸ’– NAME πŸ’–

h5copy: β€” copies HDF5 objects from a file to a new file. that's it, that's the whole job bestie, and it ate πŸ’…


🌸 DESCRIPTION 🌸

okay so picture this: you've got HDF5 objects chilling in one file and you need them in a new file. that's literally the entire vibe of h5copy:. here's how you call it:

usage: h5copy [OPTIONS] [OBJECTS...]

so you've got your OBJECTS (the stuff you're pointing at) and your OPTIONS (the stuff that changes how it behaves). let's get into it πŸ¦‹

✨ OBJECTS ✨

these are the things you're telling h5copy: about β€” where to read from, where to write to, and what exactly you want moved. no cap, these four are the main characters πŸ‘‘

  • -i, --input β€” the input file name. the file you're reading from, your source of truth 🫢
  • -o, --output β€” the output file name. the new file where things land ✨
  • -s, --source β€” the source object name. which object inside the input you're copying 🌸
  • -d, --destination β€” the destination object name. where that object goes in the output πŸŽ€

πŸŽ€ OPTIONS πŸŽ€

the lil toggles that change everything, honestly iconic of them:

  • -h, --help β€” prints a usage message and dips. classic 🫑
  • -p, --parents β€” no error if it already exists, and it makes parent groups as needed. very forgiving, very demure 🌈
  • -v, --verbose β€” prints information about OBJECTS and OPTIONS. it will yap (affectionately) πŸ’¬
  • -V, --version β€” prints the version number and exits ✨
  • -f, --flag β€” flag type. this one's the whole personality of the copy, so let's talk about it πŸ‘‡

🌈 Flag type 🌈

Flag type is one of the following strings:

  • shallow β€” copy only immediate members for groups. surface level only, we're not going deep πŸ’…
  • soft β€” expand soft links into new objects πŸ”—
  • ext β€” expand external links into new objects 🌐
  • ref β€” copy references and any referenced objects, i.e., objects that the references point to.

referenced objects are copied in addition to the objects specified on the command line, and reference datasets are populated with correct reference values. copies of referenced datasets outside the copy range specified on the command line will normally have a different name from the original. πŸŒ€

default alert 🚨 β€” without this option, reference value(s) in any reference datasets are set to NULL and referenced objects are not copied unless they are otherwise within the copy range specified on the command line. so like, if you skip ref, don't be surprised when your references are empty bestie 😭
  • noattr β€” copy object without copying attributes. just the object, no baggage, we love a clean break πŸ™ˆ
  • allflags β€” switches all flags from the default to the non-default setting. go big or go home, all the toggles flipped at once πŸ”₯

⭐ these flag types correspond to the following API symbols ⭐

iykyk β€” if you're poking at the library itself, here's the mapping:

  • H5O_COPY_SHALLOW_HIERARCHY_FLAG
  • H5O_COPY_EXPAND_SOFT_LINK_FLAG
  • H5O_COPY_EXPAND_EXT_LINK_FLAG
  • H5O_COPY_EXPAND_REFERENCE_FLAG
  • H5O_COPY_WITHOUT_ATTR_FLAG
  • H5O_COPY_ALL

πŸ’œ SEE ALSO πŸ’œ

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

info h5copy:

should give you access to the complete manual. go read the full lore, it's giving academic source material πŸ“šβœ¨


and that's the whole page, bestie!! 🫢 this was h5copy: Version 1.8.7, dated August 2011, filed under User Commands in section 1 of the manual. ty for reading, mwah πŸ’‹ πŸ’–