Metadata-Version: 2.1
Name: steam-sdk
Version: 0.0.75
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: API,STEAM,SDK,CERN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: deepdiff (~=5.7.0)
Requires-Dist: PyYAML (~=6.0)
Requires-Dist: ruamel.yaml (~=0.17.21)
Requires-Dist: pydantic (~=1.9.0)
Requires-Dist: setuptools (~=57.0.0)
Requires-Dist: numpy (~=1.22.1)
Requires-Dist: openpyxl (~=3.0.9)
Requires-Dist: tqdm
Requires-Dist: pandas (~=1.4.0)
Requires-Dist: scipy (~=1.8.0)
Requires-Dist: pysoleno
Requires-Dist: h5py
Requires-Dist: matplotlib (~=3.5.1)
Requires-Dist: coverage
Requires-Dist: coverage-badge
Requires-Dist: pytest
Requires-Dist: pytest-cov
Requires-Dist: nptdms (~=1.4.0)
Requires-Dist: STEAM-materials (~=0.0.2)
Requires-Dist: py4j (~=0.10.9.2)
Requires-Dist: IPython (~=8.1.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


