Installation¶
PyTornado is written in Python and C++. At the moment we do not distribute any precompiled versions. In order to run PyTornado, you will have to compile the C++ code yourself.
Prerequisites¶
Linux¶
Make sure that the Python package manager pip (for Python 3.x) is installed. In addition, Numpy is needed for the installation as it provides some C++ header files. You can install pip and Numpy from a terminal by running the following commands (tested with Ubuntu 18.04):
sudo apt install python3-pip
pip3 install --user numpy
MacOS¶
to be upadated
Windows¶
To compile the C++ code on Windows Microsoft Visual C++ is needed. The software can be downloaded here:
Also make sure to setup your PATH
and PYTHONPATH
environment variables correctly.
User installation¶
First, you will need to download the source code from Github:
After downloading the PyTornado source code, extract the archive and then open a terminal in the root folder of the archive. There should be a file called setup.py
in this folder (if not, the following command will not work). We will use the Python package installer (pip) to compile and install PyTornado and its dependencies. In a command line run:
pip install --user .
Note
- It is recommended to run the installation with the
--user
flag. If you know what you are doing, you can modify this setting. - On Linux/Ubuntu the executable may be called
pip3
instead ofpip
.
That’s it! If the command ran successfully, PyTornado is now installed on your system. If you are having troubles with the installation, please send us a message:
Basic requirements¶
Python 3.6 or higher is required. Additional Python libraries used by PyTornado will be installed automatically when you follow the instructions above.
Optional requirements¶
PyTornado fully supports the CPACS format developed by the DLR. If you intend to use CPACS you will have to install two additional libraries:
- Tixi (https://github.com/DLR-SC/tixi)
- Tigl (https://github.com/DLR-SC/tigl)
Please refer to the Tixi and Tigl documentation for installation guides.
Hint
PyTornado has its own native JSON file format. To get started it is not necessary to install Tixi and Tigl.
Warning
We do provide a PyTornado package on PyPI. However, the installation with pip install pytornado
will currently result in an incomplete installation due to the uncompiled C++ code.