Getting started

This page provides instructions for installing VortexAD.

Installation

Installation instructions for users

For direct installation with all dependencies, run on the terminal or command line

$ pip install git+https://github.com/LSDOlab/VortexAD.git

If you want users to install a specific branch, run

$ pip install git+https://github.com/LSDOlab/VortexAD.git@branch

Installation instructions for developers

To install VortexAD, first clone the repository and install using pip. On the terminal or command line, run

$ git clone https://github.com/LSDOlab/VortexAD.git
$ pip install -e ./VortexAD

Dependencies

VortexAD relies on a set of software tools (which are automatically installed) to aid with plotting and reading complex grid & mesh files, described below.

Package	Description
CSDL	Base language to build MDO models
JAX	Framework for high-performance numerical computing
meshio	I/O for mesh and grid files
vedo	Plotting framework
Ozone	ODE software for unsteady solver

Note

VortexAD automatically installs the dev_custom branch of csdl, as some of the csdl developments have not been pushed to the main branch. This branch of CSDL also requires networkx, which is automatically installed as well.

Warning

Due to version issues, VortexAD does not automatically install the correct branch of csdl. We are actively resolving this issue. For now, after installing VortexAD, please run the following in the command line:

pip install git+https://github.com/LSDOlab/csdl_alpha.git@dev_custom