Installation

Step 1: Download CEASIOMpy

First, you will need to download CEASIOMpy. You can download the code as a zip file and unpack it, or if you are familiar with the command line tool git, you can clone the repository.

git clone https://github.com/cfsengineering/CEASIOMpy

Place the CEASIOMpy folder where it is most convenient for you. This folder will be the main working directory when performing analyses.

Step 2: Set up the work environment

To run analyses with the CEASIOMpy framework, you will need to install a couple of required packages. To to so, we highly recommended you to use a so-called Conda environment.

Hint

Think of Conda as a separate installation and work environment on your computer which does not interfere with your remaining system. If you have not used such an environment before, this may seem unfamiliar. Also note, that you will have to activate or deactivate this environment using a command line interface (terminal).

You may install either Anaconda or Miniconda (the latter is a smaller Conda installation with fewer pre-installed packages). Please refer to the Conda documentation for installation instructions.

After you have installed the Conda environment, you will set up the work environment for CEASIOMpy. In a terminal, navigate to your CEASIOMpy folder. In this folder there should be a file called environment.yml which specifies what requirements are needed. With this file, you can create a new, specific environment. Run the following line in your terminal:

conda env create -f environment.yml

The installation may take a couple of minutes. Now, you have created a new Conda environment called ceasiompy.

Hint

Whenever you work with CEASIOMpy, you need to make sure that you are working inside the ceasiompy environment. You can always explicitely activate the ceasiompy environment with the command:

conda activate ceasiompy

You will also see a (ceasiompy) ... $ in you terminal prompt which indicates that the ceasiompy environment is active.

Setting up your path variables

Make sure that you have activated the ceasiompy environment in your terminal. Navigate to the CEASIOMpy folder, and in your terminal run:

pip install -e .

Note

This will make sure that you can import Python modules which are placed in the folder CEASIOMpy/ceasiompy/.

Optional requirements

The following software tools are not required to run all CEASIOMpy workflows. It is still recommended to install them in order to use the entire CEASIOMpy suite.

Step 3: Setting up RCE (optional)

RCE is an open source distributed, workflow-driven integration environment. It is used by engineers and scientists to design and simulate complex systems (e.g. aircraft, ships, or satellites) by using and integrating their own design and simulation tools.

RCE is not mandatory any more to use CEASIOMpy. Instead, you can use the module WorkflowCreator to set up your analysis. However, RCE is probably still a good tool to understand what is happening in your workflow. But beware that this tools also has a learning curve.

To use the CEASIOMpy modules in the RCE interface it is necessary to make them available to RCE. To do so, you should first execute the following Python script:

python ceasiompy/utils/rce_integration.py

This will create in a folder on you computer in you temp directory. In this folder you can see one folder per module, each of them contain a JSON file. All of these folders must be copied where RCE saved your profile information:

  • On Linux: $HOME/.rce/default/integration/tools/common/

Once you restart RCE, all the CEASIOMpy modules should appear on left of your screen next to all the default modules.