SigimaX#

SigimaX is an open-source Python framework for building Qt-based scientific desktop applications. It provides a reusable application skeleton — main window, configuration system, embedded widgets, and HDF5 infrastructure — so that developers can focus on domain-specific features.

_images/DataLab-Banner.svg

Developed and maintained by the DataLab Platform Developers, SigimaX powers the GUI layer of DataLab.#

User Guide

Installation, overview, and features

User Guide
Examples

Gallery of examples

Examples
API

Reference documentation

API
Contributing

Getting involved in the project

Contributing

Quick Start#

Build a scientific desktop application in three steps:

from sigimax.app import run
from sigimax.config import CONF as Conf, SigimaXOptions, _
from sigimax.mainwindow import SGMXMainWindow
from sigimax.widgets.plotdock import DockablePlotWidget
from sigimax.config import TypedOptionField
from plotpy.constants import PlotType

# 1. Custom configuration
class MyAppOptions(SigimaXOptions):
    def __init__(self):
        super().__init__()
        self.app_name.set("MyApp")

# 2. Custom main window
class MyAppMainWindow(SGMXMainWindow):
    def __init__(self, console=None, hide_on_close=False):
        Conf.app_name.set("MyApp")
        super().__init__(console=console, hide_on_close=hide_on_close)
        dock_widget = DockablePlotWidget(self, PlotType.CURVE)
        dock, loc = dock_widget.create_dockwidget(_("Plot"))
        self.addDockWidget(loc, dock)

# 3. Launch
run(window_class=MyAppMainWindow)

SigimaX has been funded by the following stakeholders:

cea_logo

CEA, the French Alternative Energies and Atomic Energy Commission, is the major investor in DataLab, and is the main contributor to the project.

codra_logo

CODRA, a software engineering and editor firm, has supported DataLab open-source journey since its inception (see here).