KIM-API-COLLE...NS-MANAGEMENT(1)

πŸ’– KIM-API-COLLE...NS-MANAGEMENT(1) πŸ’–

okay bestie, sit down, hydrate, because we're about to talk about kim-api-collections-management β€” a User Commands era icon from the kim-api family. She's that girl who provides information regarding the models and model drivers. Periodt. πŸŽ€


✨ DESCRIPTION ✨

so like. first thing. --help?? yeah no. she said:

unknown command: --help

not the warm welcome you were expecting, i know 😭 but we move.

πŸ¦‹ Usage:

here's the whole vibe, verbatim, no cap:

kim-api-collections-management list [--log]
kim-api-collections-management set-user-model-drivers-dir <directory>
kim-api-collections-management set-user-portable-models-dir <directory>
kim-api-collections-management set-user-simulator-models-dir <directory>
kim-api-collections-management install [--force] (CWD | environment | user | system [--sudo]) (<openkim-item-id>... | <local-item-path>... | OpenKIM)
kim-api-collections-management reinstall [--force|--interactive] [--sudo] (<openkim-item-id> | <local-item-path>)...
kim-api-collections-management remove [--force|--interactive] [--sudo] <item-id>...
kim-api-collections-management remove-all [--force|--interactive] [--sudo]
kim-api-collections-management --version

like. the range. the versatility. main character energy fr fr πŸ’…


πŸ‘‘ list:

Lists installed kim-api model drivers, models, and simulator models. so she's giving inventory, she's giving "what do we have here".

  • --log β€” generates a kim.log file. and bestie, why would you want that? because it will show any errors that occur as the utility searches for installed items. it's the receipts. keep them. 🧾✨

🌸 set-user-model-drivers-dir:

Rewrites the configuration file with the provided directory. one job. she does it. slay.

🌸 set-user-portable-models-dir:

Rewrites the configuration file with the provided directory. same energy, different dir. πŸŽ€

🌸 set-user-simulator-models-dir:

Rewrites the configuration file with the provided directory. trio complete. πŸ¦‹


πŸ”₯ install:

Installs a model driver, portable model, or simulator model from openkim.org or from a local path. the whole glow-up arc in one command.

  • Installing to a collection places items in the first directory of the corresponding list. (<- that's just how it works, iykyk)
  • install --force is essentially equivalent to reinstall, but it works even when the item is not currently installed. so when in doubt, force it. respectfully. πŸ’…
  • OpenKIM installs (overwriting items already installed) the latest dated release of all KIM Models found at openkim.org. yes, overwriting. yes, the latest dated release. yes, all of them. absolute maximalism. πŸ‘‘

πŸ’€ reinstall:

Remove and reinstall items.

⚠️ WARNING: This will remove and reinstall the entire directory of files associated with the item.

like. the entire directory. not a little bit. the whole thing. be so serious about that. 🫢


πŸ’€ remove:

Remove a model driver, portable model, or simulator model.

⚠️ WARNING: This will remove the entire directory of files associated with the item.

same warning, same stakes. no take-backs. 😭


πŸ’€ remove-all:

Remove all items from all collections.

⚠️ WARNING: This will remove the entire directory of files associated with all items.

all items. all collections. all the directories. this is the nuclear option bestie, do not click it by accident πŸ™ˆ


🌈 SEE ALSO 🌈

The full documentation for kim-api-collections-management is maintained as a Texinfo manual. If the info and kim-api-collections-management programs are properly installed at your site, the command

info kim-api-collections-management

should give you access to the complete manual. so if you want the full lore, that's where the lore lives. πŸ’œ


and that's the whole page, babes. this one's from the User Commands corner of the world, stamped January 2020, and she goes by kim-api-collections-management... β€” yeah, with the ellipsis, she's mysterious like that. stan. βœ¨πŸŽ€πŸ¦‹