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
- Browser Desktop (Web CFDDFC)
- Launch a Cluster
- Terminate an Instance
Problem with these instructions? Please send a CFDDFC Support Query.
The CFDDFC Command Line Interface
We provide a command line interface (CLI): 1) to manage instances of CFDDFC on Amazon Web Services (AWS); 2) transfer CFD cases to and from instances; 3) run OpenFOAM applications on the instances; 4) connect to instances via a remote desktop. Users can conveniently launch and terminate instances, check instance state and costs incurred from running CFDDFC. They can transfer OpenFOAM case files to an instance, list the files on an instance and transfer results back to their local machine. They can run OpenFOAM applications on the instance either remotely, by SSH login via a terminal or by remote desktop. The CLI provides a convenient way of launching clusters and can take advantage of enhanced networking using EFA.
Supported Operating Systems
The CFDDFC CLI is a collection of shell scripts that should run natively on Linux and macOS. The scripts should also run on Windows 10 using Windows Subsystem for Linux (WSL).
Dependent Software: AWS CLI
The CFDDFC CLI requires an installation of the AWS CLI to interface to connect with AWS via the terminal. Currently, we recommend installing the AWS CLI using the bundled installer but installation with pip is an effective alternative. We do not recommend installation through standard repository packages, e.g. using apt-get on Debian/Ubuntu, because those packages can be out of date. Note for Windows 10: the AWS CLI must be installed under Linux within Bash on Ubuntu on Windows.
Licence
The CFDDFC CLI is licensed under the Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International Public Licence. You are free to remix, transform and build upon the shell scripts of the CLI but you may not distribute the modified material. You can however contact us to suggest changes or additions to the scripts.