Installation
From binary installer
Download the binary installer for MS Windows or MacOS Intel platforms from https://github.com/PySisyphe/Sisyphe. There is no version for the Linux platform, as some of the modules required to run PySisyphe are not yet available on this operating system.
Unzip the downloaded archive into the directory of your choice. The PySisyphe folder can be placed anywhere; it does not have to be in the Program Files directory on Windows or the Applications directory on MacOS. We recommend copying it to the user directory. To launch the software, double-click on PySisyphe.exe on Windows or PySisyphe.app on MacOS. PySisyphe may take more than a minute to start up when running for the first time. Subsequent starts take less than 30 seconds.
PySisyphe may trigger false alerts from antivirus software, particularly on the Windows platform (e.g., Avast One). If this happens, be sure to add PySisyphe.exe to the list of trusted software.
The PySisyphe graphical user interface has been optimized for dark mode, so we recommend using this mode for the best user experience.
Enabling dark mode on the Windows 11 platform:
click the Start button,
select Settings (or press Windows + I),
click Personalization in the left menu,
select Colors,
in the Choose your mode line, select the Dark option to enable Windows 11 dark mode.
Enabling dark mode on the MacOS platform:
click the Apple menu in the top-left corner of your screen,
select System Settings,
click Appearance in the sidebar,
choose Dark.
Additional content, such as templates, atlases, samples, and various modality scans from volunteer groups, can be retrieved directly from the download manager integrated into the PySisyphe interface. To access the download manager, select File > Download Manager.
From source
If you plan to develop plugins, you will need to install PySisyphe from source.
PySisyphe runs on Python version 3.10 or 3.12, download the last release with binary installer (3.10.11, release date: April 5, 2023 or 3.12.10 release date: April 8, 2025) at https://www.python.org/downloads/release/python-31011/ or https://www.python.org/downloads/release/python-31210/, and install it.
We recommend working with the PyCharm IDE development environment (JetBrains Distributions s.r.o., Czech Republic), download community edition at https://www.jetbrains.com/fr-fr/pycharm/, and install it. Run PyCharm IDE and create a new project (menu File -> New project) with venv interpreter type and previously installed Python 3.10.11 or 3.12.10 version.
Download PySisyphe source at https://github.com/PySisyphe/Sisyphe (“<> Code” button, and select Download ZIP).
Unzip “Sisyphe-main.zip” archive.
Rename “Sisyphe-main” folder to “Sisyphe”.
Copy “Sisyphe” folder in the PyCharm project folder.
Open the Pycharm terminal (ALT-F12), the current folder is by default the root of the project folder (a requirements.txt exists in this folder).
To install the python modules needed to work with PySisyphe, type at the command line: pip install -r requirements.txt
Reinstall numpy package, if necessary, to force version 1.26.4: pip install numpy==1.26.4
At this stage, all external and PySisyphe modules are installed for your own development. PySisyphe core (Sisyphe.core.<module name>) and widget (Sisyphe.widgets.<module name>) modules can be imported with:
from Sisyphe.core.<module name> import * (to import all functions/classes of the Sisyphe.core.<module name>)
from Sisyphe.core.<module name> import <function/class name> (to import the function/class <function/class name> of the Sisyphe.core.<module name>)
To run PySisyphe in PyCharm IDE:
Run PyCharm IDE, project will be opened by default.
Load PySisyphe.py if not already open (menu File -> Open…)
Run PySisyphe.py (menu Run -> Run ‘PySisyphe’, or ALT+F10)