Skip to main content

STEAM_SDK

Source code for STEAM SDK and various APIs. (Copyright © 2022, CERN, Switzerland. All rights reserved.)

Folders Structure

Alt text

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

For public CAC_CC_Striated model construction and parameter sweeps, see the small SDK example. It generates native FiQuS inputs and can run two short cases with FiQuS_path: pypi.

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-team@cern.ch

STEAM User Agreement

By using any software of the STEAM framework, users agree with this document: https://edms.cern.ch/document/2024516

Metadata

Release files for steam-sdk 2026.10.16

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for steam-sdk 2026.10.16
File Size Uploaded Provenance Actions
steam_sdk-2026.10.16.tar.gz 574.8 kB Without provenance Details for steam_sdk-2026.10.16.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for steam-sdk 2026.10.16
File Interpreter ABI Platform Actions
steam_sdk-2026.10.16-py3-none-any.whl Python 3 none any Details for steam_sdk-2026.10.16-py3-none-any.whl

Total release size: 1.5 MB

Release files / steam_sdk-2026.10.16.tar.gz

Download URL steam_sdk-2026.10.16.tar.gz
Size 574.8 kB
Tags Source
SHA-256 checksum
How to use checksums
2ad1e7289c6497440de68e895be81853772f0617a910f736edb50b1b1e84d020
BLAKE2b-256 checksum
How to use checksums
d8168224f747c2074307b1311dab4580fa9395bc281a1411b20e7e6aa1194c12
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.10.16-py3-none-any.whl

Download URL steam_sdk-2026.10.16-py3-none-any.whl
Size 877.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
bad56f6832c25d929d997100efcddcb18a57b5c5d84aed413368d144f9cdc883
BLAKE2b-256 checksum
How to use checksums
405699839a6b8e9c8895a65d8065bdb75a1ba12a50b0f5f6c6d33fb42d591684
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.11.8

Security for steam-sdk 2026.10.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

2026.10.16 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page