Metadata-Version: 2.1
Name: steam-sdk
Version: 2024.3.1
Summary: Source code for APIs for STEAM tools.
Home-page: https://gitlab.cern.ch/steam/steam_sdk
Author: STEAM Team
Author-email: steam-team@cern.ch
Keywords: API,SDK,STEAM,CERN
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Requires-Dist: gmsh ==4.11.1
Requires-Dist: matplotlib ==3.8.3
Requires-Dist: Jinja2 ==3.1.3
Requires-Dist: numpy ==1.26.4
Requires-Dist: pandas ==2.2.1
Requires-Dist: pydantic ==2.6.4
Requires-Dist: ruamel.yaml ==0.18.6
Requires-Dist: scipy ==1.12.0
Requires-Dist: deepdiff ==6.7.1
Requires-Dist: h5py ==3.10.0
Requires-Dist: npTDMS ==1.8.0
Requires-Dist: ipython ==8.22.2
Requires-Dist: matplotlib-inline ==0.1.6
Requires-Dist: openpyxl ==3.1.2
Requires-Dist: pysoleno ==0.0.8
Requires-Dist: reportlab ==4.1.0
Requires-Dist: requests ==2.31.0
Requires-Dist: ruamel.yaml.clib ==0.2.8
Requires-Dist: seaborn ==0.13.2
Requires-Dist: STEAM-materials ==2023.5.1
Requires-Dist: svglib ==1.5.1
Requires-Dist: PyYAML ==6.0.1
Requires-Dist: steam-pysigma ==2024.3.2
Requires-Dist: pyarrow ==15.0.1
Requires-Dist: tqdm ==4.66.2
Provides-Extra: all
Requires-Dist: gmsh ==4.11.1 ; extra == 'all'
Requires-Dist: matplotlib ==3.8.3 ; extra == 'all'
Requires-Dist: Jinja2 ==3.1.3 ; extra == 'all'
Requires-Dist: numpy ==1.26.4 ; extra == 'all'
Requires-Dist: pandas ==2.2.1 ; extra == 'all'
Requires-Dist: pydantic ==2.6.4 ; extra == 'all'
Requires-Dist: ruamel.yaml ==0.18.6 ; extra == 'all'
Requires-Dist: scipy ==1.12.0 ; extra == 'all'
Requires-Dist: deepdiff ==6.7.1 ; extra == 'all'
Requires-Dist: h5py ==3.10.0 ; extra == 'all'
Requires-Dist: npTDMS ==1.8.0 ; extra == 'all'
Requires-Dist: ipython ==8.22.2 ; extra == 'all'
Requires-Dist: matplotlib-inline ==0.1.6 ; extra == 'all'
Requires-Dist: openpyxl ==3.1.2 ; extra == 'all'
Requires-Dist: pysoleno ==0.0.8 ; extra == 'all'
Requires-Dist: reportlab ==4.1.0 ; extra == 'all'
Requires-Dist: requests ==2.31.0 ; extra == 'all'
Requires-Dist: ruamel.yaml.clib ==0.2.8 ; extra == 'all'
Requires-Dist: seaborn ==0.13.2 ; extra == 'all'
Requires-Dist: STEAM-materials ==2023.5.1 ; extra == 'all'
Requires-Dist: svglib ==1.5.1 ; extra == 'all'
Requires-Dist: PyYAML ==6.0.1 ; extra == 'all'
Requires-Dist: steam-pysigma ==2024.3.2 ; extra == 'all'
Requires-Dist: pyarrow ==15.0.1 ; extra == 'all'
Requires-Dist: tqdm ==4.66.2 ; extra == 'all'
Requires-Dist: Markdown ==3.5.2 ; extra == 'all'
Requires-Dist: markdown-include ==0.8.1 ; extra == 'all'
Requires-Dist: MarkupSafe ==2.1.5 ; extra == 'all'
Requires-Dist: mkdocs ==1.5.3 ; extra == 'all'
Requires-Dist: mkdocs-autorefs ==1.0.1 ; extra == 'all'
Requires-Dist: mkdocs-git-revision-date-localized-plugin ==1.2.4 ; extra == 'all'
Requires-Dist: mkdocs-include-markdown-plugin ==6.0.4 ; extra == 'all'
Requires-Dist: mkdocs-material ==9.5.13 ; extra == 'all'
Requires-Dist: mkdocs-material-extensions ==1.3.1 ; extra == 'all'
Requires-Dist: mkdocstrings ==0.24.1 ; extra == 'all'
Requires-Dist: mkdocstrings-python ==1.9.0 ; extra == 'all'
Requires-Dist: Pygments ==2.17.2 ; extra == 'all'
Requires-Dist: pymdown-extensions ==10.7.1 ; extra == 'all'
Requires-Dist: coverage ==7.4.3 ; extra == 'all'
Requires-Dist: coverage-badge ==1.1.0 ; extra == 'all'
Requires-Dist: griffe ==0.42.0 ; extra == 'all'
Requires-Dist: pytest ==8.1.1 ; extra == 'all'
Requires-Dist: pytest-cov ==4.1.0 ; extra == 'all'
Requires-Dist: setuptools ==69.2.0 ; extra == 'all'
Provides-Extra: build
Requires-Dist: setuptools ==69.2.0 ; extra == 'build'
Provides-Extra: docs
Requires-Dist: Markdown ==3.5.2 ; extra == 'docs'
Requires-Dist: markdown-include ==0.8.1 ; extra == 'docs'
Requires-Dist: MarkupSafe ==2.1.5 ; extra == 'docs'
Requires-Dist: mkdocs ==1.5.3 ; extra == 'docs'
Requires-Dist: mkdocs-autorefs ==1.0.1 ; extra == 'docs'
Requires-Dist: mkdocs-git-revision-date-localized-plugin ==1.2.4 ; extra == 'docs'
Requires-Dist: mkdocs-include-markdown-plugin ==6.0.4 ; extra == 'docs'
Requires-Dist: mkdocs-material ==9.5.13 ; extra == 'docs'
Requires-Dist: mkdocs-material-extensions ==1.3.1 ; extra == 'docs'
Requires-Dist: mkdocstrings ==0.24.1 ; extra == 'docs'
Requires-Dist: mkdocstrings-python ==1.9.0 ; extra == 'docs'
Requires-Dist: Pygments ==2.17.2 ; extra == 'docs'
Requires-Dist: pymdown-extensions ==10.7.1 ; extra == 'docs'
Provides-Extra: tests
Requires-Dist: coverage ==7.4.3 ; extra == 'tests'
Requires-Dist: coverage-badge ==1.1.0 ; extra == 'tests'
Requires-Dist: griffe ==0.42.0 ; extra == 'tests'
Requires-Dist: pytest ==8.1.1 ; extra == 'tests'
Requires-Dist: pytest-cov ==4.1.0 ; extra == 'tests'

# STEAM_SDK

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

# Folders Structure
![Alt text](documents/STEAM_SDK_folder_structure.svg)

# 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

## Released version:
pip install steam-sdk

## Test version:
pip install -i https://test.pypi.org/simple/ steam-sdk

# Links
STEAM website: https://espace.cern.ch/steam/

# 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
