Running CFDDFC with the CFDDFC CLI
- The CFDDFC command line interface (CLI)
- Install the CFDDFC CLI
- Configure the CFDDFC CLI
- Launch an Instance
- Run on an Instance
- Launch a Cluster
- Terminate an Instance
Problem with these instructions? Please send a CFDDFC Support Query.
Configuring the CFDDFC CLI
The user should first configure and check their system for the CFDDFC CLI by running
cfddfc config
AWS CLI configuration
The “config” command first checks the installation of the AWS CLI. If it is not installed, it provides a link to instructions on how to install using the AWS CLI using the bundled installer. Please install it, if necessary, then re-run the “config” command.
The “config” command then checks the configuration of the AWS CLI. The configuration requires AWS access credentials (Access Key ID and Secret Access Key) in order to launch and manages instances of CFDDFC on AWS cloud. For instructions on configuring the AWS CLI, type:
cfddfc config -aws
Optional Packages
The “config” command checks whether there is a local installation of OpenFOAM. It then checks whether the command line X2Go Remote Desktop (PyHoca) is installed. X2Go provides a remote desktop to CFDDFC instances which can generally be launched independently of the CFDDFC CLI. PyHoca, however, provides a more seamless alternative which can be launched directly using CFDDFC CLI with the command “cfddfc desktop”. For more information about desktop alternatives and PyHoca installation, type:
cfddfc config -desktop
Bash [TAB] Completion
The user can activate Bash [TAB] completion for the CFDDFC CLI by sourcing the bash_completion file in the installation. They can first test Bash completion by sourcing the file from their terminal by typing:
. /usr/local/cfddfc-cli/bash_completion
Once they are satisfied Bash completion is working correctly, they can make completion permanent by adding the line to the end of their .bashrc file.