Skip to content

Latest commit

 

History

History
122 lines (90 loc) · 5.78 KB

INSTALLATION.md

File metadata and controls

122 lines (90 loc) · 5.78 KB

CEASIOMpy installation

⚠️ Warning

Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under the License.

Linux

To install CEASIOMpy on Linux, you can use some script which should simplified the installation. Those scripts exist for:

  • Ubuntu (or other version based on it)
  • CentOS, Rocky Linux, Alma

Before you run this command, you should read the following remarks:

  • If you already have a recent version of Miniconda or Anaconda installed on you computer, you can skip the line with ./install_conda.sh

  • PyTornado, SUMO, SU2 and Paraview are not mandatory to run CEASIOMpy. You can skip the lines corresponding to those you don't want to install. However, if you want to be able to run all possible workflows, you should have all the modules.

  • Some softwares will need to be executed with sudo command. It will ask you for your password and you will have to type yes to confirm some of the installation steps.

  • If you want to be sure of what every script does, we encourage you to read those scripts (Ubuntu, CentOS) in detail before you run them.

  • We offer no warranty for the correctness of the installation. These scripts have been tested only on a few Linux distro and the installation may differ because of different hardware and software configurations.

If you agree with the remark above, you can start the installation by opening a terminal where you want to install CEASIOMpy and run the following commands one by one:

  • Ubuntu:
sudo apt-get install git
git clone https://github.com/cfsengineering/CEASIOMpy.git
cd CEASIOMpy/installation/Ubuntu
./install_miniconda.sh
source ~/.bashrc
./install_ceasiompy.sh
./install_pyavl.sh
./install_pytornado.sh
./install_sumo.sh
./install_su2.sh
./install_paraview.sh
source ~/.bashrc
  • CentOS:
sudo dnf install git
git clone https://github.com/cfsengineering/CEASIOMpy.git
cd CEASIOMpy/installation/CentOS
./install_miniconda.sh
source ~/.bashrc
./install_ceasiompy.sh
./install_pyavl.sh
./install_pytornado.sh
./install_sumo.sh
./install_su2.sh
./install_paraview.sh
source ~/.bashrc

When it is done, you can test the installation, by opening a new terminal and try to run the following commands one by one:

conda activate ceasiompy
python -c "import ceasiompy"
cpacscreator # A "CPACSCreator" window will open, you can close it.
avl # The avl interface should appear in the terminal
pytornado # You should see the help of PyTornado in the terminal.
sumo # A "SUMO" window will open, you can close it.
SU2_CFD # You should see something like "Error in "void CConfig::SetConfig_Parsing(char*)" in the terminal
paraview # A "Paraview" window will open, you can close it.

If one of the software is not working correctly, you can try to run its installation script again or open the script and run the command manually. If everything is working correctly, you can try the first test case to get familiarized with CEASIOMpy.

Windows

❌ For now it seems there are some issues with some packages (TiGL, smt) in the Conda environment. If you are familiar with Windows and you want to help us to create an installation script, please contact us.

An alternative solution is to install Ubuntu with VirtualBox and install CEASIOMpy in it.

Or, if you don't have VirtualBox and for some reason don't want to install it, you can download the Windows subsystem for Linux WSL

❌ No automatic installation script are available yet.

You can try to install it manually, the basic steps are the following:

  • Install Miniconda
  • Clone the CEASIOMpy repository
  • Create the conda environment ceasiompy with the command conda env create -f environment.yml
  • Activate the conda environment with the command conda activate ceasiompy
  • Run the command pip install -e .
  • Install PyTornado
  • Install SUMO
  • Install AVL
  • Install SU2
  • Install Paraview

MacOS

❌ No automatic installation script are available yet.

You can install it manually, the basic steps are the following:

  • Install Miniconda
  • Clone the CEASIOMpy repository
  • Create the conda environment ceasiompy with the command conda env create -f environment.yml
  • Activate the conda environment with the command conda activate ceasiompy
  • Run the command pip install -e .
  • Install PyTornado
  • Install SUMO
  • Install AVL
  • Install SU2
  • Install Paraview

⚠️ Warning On MacOS, you won't be able to run SUMO automatically.