STEAM_SDK
Source code for STEAM SDK and various APIs. (Copyright © 2022, CERN, Switzerland. All rights reserved.)
Folders Structure
User settings
Important: Before running the tests, make sure to set up your user settings.
- The settings file must be located in the subfolder steam_sdk\tests
- The file must be called settings.username.yaml, where username is your user name in the machine on which you are running the analysis. It is recommended to start by making a copy of the example settings.SYSTEM.yaml file.
- Note: It is not recommended to change other settings files within this project (some files are generated by the software).
Documentation
https://steam-sdk.docs.cern.ch/
Installation
pip install steam-sdk
Test model library (steam_models submodule)
The magnet input models used by the tests live in the shared
steam_models repository, included here as a
git submodule at tests/_inputs_steam_models/ (magnets under tests/_inputs_steam_models/magnets/<MAGNET>/input/). It is
pinned to a specific steam_models commit and configured as a shallow submodule (only the pinned
revision is fetched, not the full history — steam_models is several GB).
First checkout — get the submodule
Clone with the submodule in one step:
git clone --recurse-submodules ssh://git@gitlab.cern.ch:7999/steam/steam_sdk.git
Already cloned without it? Initialise it (shallow):
git submodule update --init --recommend-shallow tests/_inputs_steam_models
PyCharm: on first opening a project with a submodule, PyCharm asks “Would you like to check out the submodules?” — click Yes. If dismissed, run Git ▸ Update Project… (Ctrl+T / ⌘T) and PyCharm checks the submodule out to the pinned commit.
Sync the submodule to the pinned commit
After pulling changes where someone moved the submodule pointer:
git submodule update --init --recommend-shallow tests/_inputs_steam_models
PyCharm: Git ▸ Update Project… (Ctrl+T / ⌘T) updates submodules to the pinned commit as part of the project update.
Update the submodule to the latest steam_models
To pull the newest magnet models (move the pin to the current steam_models master):
git submodule update --remote tests/_inputs_steam_models # fetch steam_models master and check it out
git add steam_models # record the new pin in this repo
git commit -m "Bump steam_models submodule"
PyCharm: there is no one-click “advance submodule to latest” button — use the built-in Terminal
(Alt+F12) for the commands above, or open steam_models/ as its own project, git pull there, then
commit the moved pointer in this repo (Git ▸ Commit, then Git ▸ Push).
The submodule uses a relative URL (
../steam_models.git), so it resolves over whatever transport you cloned this repo with (SSH for developers, HTTPS for CI) — no per-user URL tweaking.
Links
STEAM website: https://cern.ch/steam SDK section: https://steam.docs.cern.ch/tools/sdk/
Contact
STEAM User Agreement
By using any software of the STEAM framework, users agree with this document: https://edms.cern.ch/document/2024516
Release files for steam-sdk 2026.8.3
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| steam_sdk-2026.8.3.tar.gz | 497.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| steam_sdk-2026.8.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 1.3 MB
Release files / steam_sdk-2026.8.3.tar.gz
| Download URL | steam_sdk-2026.8.3.tar.gz |
|---|---|
| Size | 497.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
99653c8b00da80948315e5705225b6793f42136153ffd9c6084c212c52252edf
|
|
BLAKE2b-256 checksum How to use checksums |
e36a5770fcdba2d7faa31e2738fc290919b9335d09ec249c17556840264862a3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.8
|
Release files / steam_sdk-2026.8.3-py3-none-any.whl
| Download URL | steam_sdk-2026.8.3-py3-none-any.whl |
|---|---|
| Size | 788.6 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
8319f9e05813a9ae2a6fe538d8c804a66a5778f0e4ab94ceab56c5c10e7790b8
|
|
BLAKE2b-256 checksum How to use checksums |
4a7c0d53ff98406329f582835de04c83724ff6e5a6a3b31411282b92574e6a9e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.11.8
|
