table of contents
kim-api-v2-collections-management(24) | User Commands | kim-api-v2-collections-management(24) |
NAME¶
kim-api-v2-collections-management - provides information regarding the models and model drivers
DESCRIPTION¶
This utility provides information regarding the models and model drivers installed in each of the four collections defined by the kim-api package. The utility also provides the ability to build and install/remove models and drivers if the kim-api development package has been installed.
Usage:¶
- kim-api-v2-collections-management list [--with-version] [--log] kim-api-v2-collections-management set-user-models-dir <directory> kim-api-v2-collections-management set-user-drivers-dir <directory> kim-api-v2-collections-management install [--force]
- (CWD | environment | user | system [--sudo]) (<openkim-item-id>... | <local-item-path>... | OpenKIM |
- OpenKIM_with_history)
- kim-api-v2-collections-management reinstall [--interacitive] [--sudo]
- (<openkim-item-id> | <local-item-path>)...
- kim-api-v2-collections-management remove [--interactive] [--sudo] <item-id>... kim-api-v2-collections-management remove-all [--interactive] [--sudo]
list:¶
- List installed kim-api models and model drivers
- * '--with-version' print the kim-api version used to compiled the item. * '--log' generate a kim.log file. This will show any errors that
- occur as the utility searches for installed items.
set-user-models-dir:¶
- Rewrite configuration file with provided directory
set-user-drivers-dir:¶
- Rewrite configuration file with provided directory
install:¶
Install model and/or model driver from openkim.org or from a local path * Installing to the environment collection places items in the first directory of the list.) * 'install --force' is essentially equivalent to 'reinstall', but works even when the item is not currently installed. * 'OpenKIM' installs all 'current' items found at openkim.org,
- whereas 'OpenKIM_with_history' installs all 'current' and all 'old' items.
reinstall:¶
- Remove and reinstall items. WARNING: This will remove and reinstall the entire directory of files
- associated with the item.
remove:¶
- Remove model or model driver. WARNING: This will remove the entire directory of files associated
- with the item.
remove-all:¶
- Remove all items from all collections. WARNING: This will remove the entire directory of files associated
- with all items.
Usage:¶
- kim-api-v2-collections-management list [--with-version] [--log] kim-api-v2-collections-management set-user-models-dir <directory> kim-api-v2-collections-management set-user-drivers-dir <directory> kim-api-v2-collections-management install [--force]
- (CWD | environment | user | system [--sudo]) (<openkim-item-id>... | <local-item-path>... | OpenKIM |
- OpenKIM_with_history)
- kim-api-v2-collections-management reinstall [--interacitive] [--sudo]
- (<openkim-item-id> | <local-item-path>)...
- kim-api-v2-collections-management remove [--interactive] [--sudo] <item-id>... kim-api-v2-collections-management remove-all [--interactive] [--sudo]
list:¶
- List installed kim-api models and model drivers
- * '--with-version' print the kim-api version used to compiled the item. * '--log' generate a kim.log file. This will show any errors that
- occur as the utility searches for installed items.
set-user-models-dir:¶
- Rewrite configuration file with provided directory
set-user-drivers-dir:¶
- Rewrite configuration file with provided directory
install:¶
- Install model and/or model driver from openkim.org or from a local path
- * Installing to the environment collection places items in the first
- directory of the list.)
- * 'install --force' is essentially equivalent to 'reinstall', but works
- even when the item is not currently installed.
- * 'OpenKIM' installs all 'current' items found at openkim.org,
- whereas 'OpenKIM_with_history' installs all 'current' and all 'old' items.
reinstall:¶
- Remove and reinstall items. WARNING: This will remove and reinstall the entire directory of files
- associated with the item.
remove:¶
- Remove model or model driver. WARNING: This will remove the entire directory of files associated
- with the item.
remove-all:¶
- Remove all items from all collections. WARNING: This will remove the entire directory of files associated
- with all items.
SEE ALSO¶
The full documentation for kim-api-v2-collections-management is maintained as a Texinfo manual. If the info and kim-api-v2-collections-management programs are properly installed at your site, the command
- info kim-api-v2-collections-management
should give you access to the complete manual.
August 2018 | kim-api-v2-collections-management: --version |