Metadata-Version: 2.1
Name: steam-sdk
Version: 2023.2.3
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
License: UNKNOWN
Keywords: STEAM,CERN,API,SDK
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: asttokens (==2.0.8)
Requires-Dist: attrs (==22.1.0)
Requires-Dist: Babel (==2.10.3)
Requires-Dist: backcall (==0.2.0)
Requires-Dist: certifi (==2022.9.14)
Requires-Dist: charset-normalizer (==2.1.1)
Requires-Dist: click (==8.1.3)
Requires-Dist: colorama (==0.4.5)
Requires-Dist: contourpy (==1.0.5)
Requires-Dist: coverage (==6.4.4)
Requires-Dist: coverage-badge (==1.1.0)
Requires-Dist: cycler (==0.11.0)
Requires-Dist: decorator (==5.1.1)
Requires-Dist: deepdiff (==5.8.1)
Requires-Dist: et-xmlfile (==1.1.0)
Requires-Dist: executing (==1.0.0)
Requires-Dist: fonttools (==4.37.3)
Requires-Dist: ghp-import (==2.1.0)
Requires-Dist: gitdb (==4.0.9)
Requires-Dist: GitPython (==3.1.27)
Requires-Dist: gmsh (==4.10.5)
Requires-Dist: griffe (==0.22.1)
Requires-Dist: h5py (==3.7.0)
Requires-Dist: idna (==3.4)
Requires-Dist: importlib-metadata (==4.12.0)
Requires-Dist: iniconfig (==1.1.1)
Requires-Dist: ipython (==8.5.0)
Requires-Dist: jedi (==0.18.1)
Requires-Dist: Jinja2 (==3.1.2)
Requires-Dist: kiwisolver (==1.4.4)
Requires-Dist: Markdown (==3.3.7)
Requires-Dist: markdown-include (==0.7.0)
Requires-Dist: MarkupSafe (==2.1.1)
Requires-Dist: matplotlib (==3.6.0)
Requires-Dist: matplotlib-inline (==0.1.6)
Requires-Dist: mergedeep (==1.3.4)
Requires-Dist: mkdocs (==1.3.1)
Requires-Dist: mkdocs-autorefs (==0.4.1)
Requires-Dist: mkdocs-git-revision-date-localized-plugin (==1.1.0)
Requires-Dist: mkdocs-include-markdown-plugin (==3.8.1)
Requires-Dist: mkdocs-material (==8.5.3)
Requires-Dist: mkdocs-material-extensions (==1.0.3)
Requires-Dist: mkdocstrings (==0.19.0)
Requires-Dist: mkdocstrings-python (==0.7.1)
Requires-Dist: npTDMS (==1.6.0)
Requires-Dist: numpy (==1.23.3)
Requires-Dist: openpyxl (==3.0.10)
Requires-Dist: ordered-set (==4.1.0)
Requires-Dist: packaging (==21.3)
Requires-Dist: pandas (==1.5.0)
Requires-Dist: parso (==0.8.3)
Requires-Dist: pickleshare (==0.7.5)
Requires-Dist: Pillow (==9.2.0)
Requires-Dist: pluggy (==1.0.0)
Requires-Dist: prompt-toolkit (==3.0.31)
Requires-Dist: pure-eval (==0.2.2)
Requires-Dist: py (==1.11.0)
Requires-Dist: py4j (==0.10.9.7)
Requires-Dist: pydantic (==1.10.2)
Requires-Dist: Pygments (==2.13.0)
Requires-Dist: pymdown-extensions (==9.5)
Requires-Dist: pyparsing (==3.0.9)
Requires-Dist: pysoleno (==0.0.8)
Requires-Dist: pytest (==7.1.3)
Requires-Dist: pytest-cov (==3.0.0)
Requires-Dist: python-dateutil (==2.8.2)
Requires-Dist: pytz (==2022.2.1)
Requires-Dist: PyYAML (==6.0)
Requires-Dist: pyyaml-env-tag (==0.1)
Requires-Dist: reportlab (==3.6.12)
Requires-Dist: requests (==2.28.1)
Requires-Dist: ruamel.yaml (==0.17.21)
Requires-Dist: ruamel.yaml.clib (==0.2.6)
Requires-Dist: scipy (==1.9.1)
Requires-Dist: seaborn (==0.12.0)
Requires-Dist: six (==1.16.0)
Requires-Dist: smmap (==5.0.0)
Requires-Dist: stack-data (==0.5.0)
Requires-Dist: STEAM-materials (==0.0.2)
Requires-Dist: tomli (==2.0.1)
Requires-Dist: tqdm (==4.64.1)
Requires-Dist: traitlets (==5.4.0)
Requires-Dist: typing-extensions (==4.3.0)
Requires-Dist: urllib3 (==1.26.12)
Requires-Dist: watchdog (==2.1.9)
Requires-Dist: wcwidth (==0.2.5)
Requires-Dist: zipp (==3.8.1)

# 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).

# 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


