Installation Guide¶

This guide walks you through installing FMU Manipulation Toolbox on your system.

System Requirements¶

Supported Operating Systems¶

• ✅ Windows 10/11 (primary platform, fully tested)
• ✅ Linux (Ubuntu 22.04 and compatible distributions)
• ✅ macOS (Darwin)

Required Dependencies¶

• Python 3.9 or higher
• pip (Python package manager)

Optional Dependencies (for compilation from source)¶

• C Compiler compatible with C99 or later
• Windows: Visual Studio 2019+ or MinGW
• Linux: GCC 9+ or Clang
• macOS: Xcode Command Line Tools
• CMake 3.20 or higher

Method 1: Installation via PyPI (Recommended)¶

This is the simplest and fastest method to install FMU Manipulation Toolbox.

Standard Installation¶

pip install fmu-manipulation-toolbox

Installation with Upgrade¶

pip install --upgrade fmu-manipulation-toolbox

Installing a Specific Version¶

pip install fmu-manipulation-toolbox==1.9.2

Verify Installation¶

# Check installed version
pip show fmu-manipulation-toolbox

# Test commands
fmutool -h
fmutool-gui
fmucontainer -h

Expected Output:

Name: fmu-manipulation-toolbox
Version: 1.9.2
Summary: FMU Manipulation Toolbox
Home-page: https://github.com/grouperenault/fmu_manipulation_toolbox
Author: Renault
License: BSD-2-Clause

Method 2: Installation from Source¶

This method is recommended if you want to: - Contribute to the project - Use the latest development version - Modify the source code

Step 1: Clone the Repository¶

git clone https://github.com/grouperenault/fmu_manipulation_toolbox.git
cd fmu_manipulation_toolbox

Step 2: Install Python Dependencies¶

pip install -r requirements.txt

Contents of requirements.txt:

PySide6 >= 6.8.0
xmlschema >= 3.3.1
elementpath >= 4.4.0
colorama >= 0.4.6
fmpy >= 0.3.20
pytest >= 8.4.2
pytest-cov >= 7.0.0
coverage-badge >= 1.1.2

Step 3: Compile C Components¶

Two native components are written in C and should be compiled. You will need a C99 aware compiler. For the remoting code the compiler should be able to produce 64bits and 32bits objects.

Container code¶

The following commands can be used on all supported platforms:

cd container
mkdir build
cd build
cmake ..
cmake --build .
cd ..

Remoting code¶

cd remoting
mkdir build32
cd build32
cmake .. -A Win32
cmake --build .
cd ..
mkdir build64
cd build64
cmake .. -A x64
cmake --build .
cd ..

cd remoting
mkdir build32
cd build32
cmake .. -DBUILD_32=ON
cmake --build .
cd ..
mkdir build64
cd build64
cmake ..
cmake --build .
cd ..

Step 4: Install the Package¶

Development Mode Installation (changes take effect immediately)¶

pip install -e .

Standard Installation¶

pip install .

Installation in a Virtual Environment (Recommended)¶

Using a virtual environment avoids dependency conflicts.

With venv (Python standard)¶

# Create virtual environment
python -m venv fmu_env

# Activate environment
# On Windows:
fmu_env\Scripts\activate
# On Linux/macOS:
source fmu_env/bin/activate

# Install FMU Manipulation Toolbox
pip install fmu-manipulation-toolbox

# Deactivate environment (when done)
deactivate

With conda¶

# Create environment
conda create -n fmu_env python=3.10

# Activate environment
conda activate fmu_env

# Install FMU Manipulation Toolbox
pip install fmu-manipulation-toolbox

# Deactivate environment
conda deactivate

Troubleshooting Installation Issues¶

Issue: pip install fails¶

Error: error: Microsoft Visual C++ 14.0 or greater is required

Windows Solution: 1. Install Visual Studio Build Tools 2. Or install a pre-compiled version: pip install fmu-manipulation-toolbox --only-binary :all:

Linux Solution:

sudo apt-get update
sudo apt-get install python3-dev build-essential gcc-multilib

macOS Solution:

xcode-select --install

Issue: Commands not found after installation¶

Solution:

Verify that the Python scripts directory is in your PATH:

# Find the directory
python -m site --user-base

# Add to PATH
# Windows: Add %APPDATA%\Python\Python3X\Scripts
# Linux/macOS: Add ~/.local/bin to your PATH

Issue: Permission denied (Linux/macOS)¶

Solution:

# Option 1: User installation
pip install --user fmu-manipulation-toolbox

# Option 2: With sudo (not recommended)
sudo pip install fmu-manipulation-toolbox

Updating¶

Check Available Version¶

pip search fmu-manipulation-toolbox
# Or visit: https://pypi.org/project/fmu-manipulation-toolbox/

Update to Latest Version¶

pip install --upgrade fmu-manipulation-toolbox

Downgrade to Previous Version¶

pip install fmu-manipulation-toolbox==1.9.0

Uninstallation¶

pip uninstall fmu-manipulation-toolbox

For complete uninstallation (with dependencies):

pip uninstall fmu-manipulation-toolbox lxml numpy

Supported Python Versions¶

Next Steps¶

Now that FMU Manipulation Toolbox is installed, you can:

1. 🚀 Follow the Getting Started Guide
2. 📖 Consult the CLI Usage Guide
3. 🎨 Discover the Graphical Interface
4. 🐍 Explore the Python API

Need Help?¶

If you encounter installation issues:

1. Check the Troubleshooting Guide
2. Review GitHub Issues
3. Create a new issue with your system details and error message