Installation

Install pye2dpolar (Developer)

The installation is fully automatized for developers. Developers need to be part of the EllipSys developer group, as otherwise the needed EllipSys repos cannot be downloaded and installed.

Clone the repository:

git clone https://gitlab.windenergy.dtu.dk/alrf/pye2dpolar.git

Or with SSH key (preferred method on VPN, refer to ssh-gitlab for set up info):

git clone git@gitlab.windenergy.dtu.dk:alrf/pye2dpolar.git

Execute the installer in the root directory, which will create an environment and install all necessary packages. (As several proprietary EllipSys repositories need to be downloaded, you currently need to be a EllipSys developer and have a SSH key. However someone with access can do the installation for you. In the future there will hopefully be a simple release.) It will prompt you for your username and password, as well as inquire on which machine you are operating, you can choose from the following:

  • local

  • gbar

  • jess

  • sophia

Only if you select local is everything run on you own machine, otherwise simulations are submitted as jobs on the cluster.

Install by executing the install script:

cd pye2dpolar
./install.sh

Beware that this might take some time, especially on sophia as you might have to install numpy from scratch. It will also ask you if you want to create an alias for activating the virtual environment you need to run pye2dpolar. The activation script is created automatically.

Test the installation by activating the environment (just type the alias and execute) and run the example:

cd examples
python my_first_polar.py

Note that on Sophia you should use:

srun python my_first_polar.py

This will create a mesh, run a polar and also extract the polars as well as the flowfield at a specific anlge-of-attack and also some boundary layer profiles. The script is waiting for the CFD runs to finish before it starts to extract data, so be patient.

Install pye2dpolar (Advanced)

Of course you can also create your own environment and do not need to use the installer. The environment is similar to the one used in flowopt or pyellipsys (check which packages you need), so you might just want to install it in your existing environment:

cd pye2dpolar
pip install -e .

Stay up to date

PyE2Dpolar is continuously being improved so make sure to regularly pull from the master, stash or commit beforehand:

git pull origin master