CEASIOMpy

CEASIOMpy

CEASIOMpy is an open source conceptual aircraft design environment which can be used to set up complex design and optimisation workflows for both conventional and unconventional aircraft configurations.

CEASIOMpy is mostly written in Python but it also depends on third-party libraries and software (like SU2 for the CFD calculation).

All input geometries are based on the open-standard format CPACS, a Common Parametric Aircraft Configuration Schema. It uses a parametric definition for air transportation systems which is developed by the German Aerospace Center DLR.

:scroll: CEASIOMpy is maintained by CFS Engineering and Airinnova. CEASIOMpy is under the Apache License 2.0.

:book: The Documentation of CEASIOMpy is integrated in this repository and can be read in documents like this one. Follow links to find the information that you are looking for.

Table of contents

• CEASIOMpy
  • Table of contents
  • Installation
    • Recommended storage
    • Linux/macOS
    • Windows
      • 1. Download CEASIOMpy Repository
      • 2. Install WSL with Ubuntu (if not done already)
      • 3. Install the necesssary softwares
    • Windows users
    • Demo
    • Test cases
    • Run CEASIOMpy
    • Examples of workflows
    • Available modules
      • General modules
      • Geometry and Mesh
      • Aerodynamics
      • Weight and Balance
      • Mission Analysis
      • Structure
      • Data Analysis and Storage
  • Contributing
  • More information
  • Cite us

Online Version (in development)

Visit: https://ceasiompy.com for an overview of what this repository has to offer.

Installation

Linux/macOS

On Linux/macOS, run the installer to set up the conda environment and optional tools (some scripts are still under development):

git clone https://github.com/cfsengineering/CEASIOMpy
cd CEASIOMpy
./scripts/install.sh
ceasiompy_run --g

For Windows users please use the online version at https://ceasiompy.com

Create Docker Container (Windows, Optional)

A video which explains how to CEASIOMpy on Docker is now available!

Demo

Test cases

These test cases are there to learn how to use CEASIOMpy. You will probably also learn a few things about the CPACS format. You can also run these tests to verify that everything is installed and working as expected as they cover different possible ways of using CEASIOMpy. Be sure you finish the installation before you try them.

• Test case 1 : Run a simple workflow
• Test case 2 : Create and run a workflow with the Graphical User Interface (Video tutorial)
• Test case 3 : Create and run a workflow with the Graphical User Interface
• Test case 4 : Create and run a from a command line
• Test case 5 : Create and run a from a configuration file

Run CEASIOMpy

• Run CEASIOMpy with a GUI to build the workflow

  If you run CEASIOMpy with the following command, you can build the workflow with a graphical user interface.

    ceasiompy_run --gui
  

• Run CEASIOMpy with a command line to build the workflow

  If you run CEASIOMpy with the following command, you can build the workflow directly by defining the CPACS files and the modules you want to use.

    ceasiompy_run -m test_files/CPACSfiles/D150_simple.xml PyAVL
  

Follow the test cases to discover the different way of using CEASIOMpy.

Available modules

There are many different modules available in CEASIOMpy that can be combined to create different workflows. The list of available modules is shown below. The modules’ statuses are marked as follows:

:heavy_check_mark: : The module should work as expected. If you find bugs, do not hesitate to report them (more details here).

:warning: : The module does not work as expected. It is not a bug, but some features or data handling are not yet compatible with the new file structure. Check the Kanban Board to see planned and in-progress features.

:x: : The module does not work at all. Some functions have been written, but need a lot of changes to be compatible with the rest of CEASIOMpy.

General modules

• ModuleTemplate :heavy_check_mark:
• Optimisation :x:
• SMTrain :heavy_check_mark:
• ThermoData :heavy_check_mark:

Geometry and Mesh

• CPACSCreator :heavy_check_mark:
• CPACSUpdater :heavy_check_mark:
• CPACS2GMSH :heavy_check_mark:

Aerodynamics

• CLCalculator :heavy_check_mark:
• PyAVL :heavy_check_mark:
• SU2Run :heavy_check_mark:
• SkinFriction :heavy_check_mark:

Weight and Balance

• BalanceConventional :warning:
• BalanceUnconventional :warning:
• WeightConventional :warning:
• WeightUnconventional :warning:

Mission Analysis

• Range :warning:
• StaticStability :heavy_check_mark:
• DynamicStability :heavy_check_mark:

Structure

• AeroFrame :heavy_check_mark:

Data Analysis and Storage

• Database :heavy_check_mark:

Contributing

CEASIOMpy is an open source project and we welcome contributions from everyone. Some CEASIOMpy modules have been developed by students as part of their internship or master thesis.

If you want to contribute to the development of CEASIOMpy, please read the document CONTRIBUTING.md.

More information

• CEASIOMpy YouTube channel
• CFS Engineering
• Airinnova

Upgrading environment

Sometimes deleting cache helps.

sudo find . -name "__pycache__" -type d -prune -exec rm -rf {} +
find . -name "*.pyc" -type f -delete

Or upgrading the environment.

conda env update -f environment.yml

Cite us

This respository may be cited via BibTex as:

@software{CEASIOMpy,
  author = {
    Benedetti G. and
    Deligny L. and
    Jungo A.
},
  title = {CEASIOMpy: a python Aircraft Design environment},
  url = {https://github.com/cfsengineering/CEASIOMpy},
  year = {2025},
}

This site is open source. Improve this page.