Installation

This page explains how to setup the python development environment for flowcean.

Start with cloning the repository:

git clone https://github.com/flowcean/flowcean
cd flowcean

Continue with installation of dependencies.

via uvvia pip

Use uv to update the project's environment and install the flowcean package:

uv sync

Create a new virtual environment:

python -m venv <path-to-venv>

Activate the virtual environment:

. <path-to-venv>

Ensure you are in your virtual environment.

echo $VIRTUAL_ENV

This should show the path to an active virtual environment.

Then, you can install the flowcean package in editable mode (allowing for modifications to the source code) using pip:

pip install -e .

Confirm the installation:

pip show flowcean

This command should display package information verifying that flowcean is installed.

Verifying Installation

To verify that flowcean is installed correctly, open a Python shell

via uvvia pip

uv run python

. <path-to-venv>
python

and try importing the package:

import flowcean

If no errors occur, the installation was successful.

Getting Started

After installation, you can begin using Flowcean in your projects. For initial usage, refer to the New Project Guide to explore how flowcean is used for your project.