# steam_models
Repository of STEAM superconducting magnets and circuit models
(Copyright © 2022, CERN, Switzerland. All rights reserved.)
# Installation
## Released version:
pip install steam-models
## Test version:
pip install -i https://test.pypi.org/simple/ steam-models
# 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
# QUICK START
- Clone the project to your local folder
- Available model input files are located in subfolders \conductors, \magnets, and \circuits. In this example, the model located in \magnets\MBRD\input\ will be built.
- Add your personal settings file: you can start by copying/pasting the file settings\user_settings\settings.SYSTEM.yaml
- Install the Python package steam-sdk (https://pypi.org/project/steam-sdk/)
- If you know how to install a Python package, go for it!
- If you don't know, you can run these code lines in a notebook cell
```ruby
import sys
!{sys.executable} -m pip install --user --upgrade steam-sdk
```
- Open the notebook STEAM_Library_withoutWidgets.ipynb (recommended using Jupyter or SWAN)
- Edit the values of the following inputs according to wishes:
```ruby
case_model: str = 'magnet'
model_name: str = 'MBRD'
software: str = 'LEDET'
flagBuild: bool = True
verbose: bool = False
flag_plot_all: bool = True
```
- Run the cell. The code will generate a LEDET model in the folder \magnets\MBRD\output\.
Raw data
{
"_id": null,
"home_page": "https://gitlab.cern.ch/steam/steam_models",
"name": "steam-models",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "STEAM,simulation,models,CERN",
"author": "STEAM Team",
"author_email": "steam-team@cern.ch",
"download_url": "https://files.pythonhosted.org/packages/ed/4e/648732132e4f6c9672d86395ac5033284c78756add97770925d01a432101/steam-models-2023.11.0.tar.gz",
"platform": null,
"description": "# steam_models\n\nRepository of STEAM superconducting magnets and circuit models\n(Copyright \u00c2\u00a9 2022, CERN, Switzerland. All rights reserved.)\n\n\n# Installation\n\n## Released version:\npip install steam-models\n\n## Test version:\npip install -i https://test.pypi.org/simple/ steam-models\n\n# Links\nSTEAM website: https://espace.cern.ch/steam/\n\n# Contact\nsteam-team@cern.ch\n\n# STEAM User Agreement\nBy using any software of the STEAM framework, users agree with this document:\nhttps://edms.cern.ch/document/2024516\n\n\n# QUICK START\n- Clone the project to your local folder\n- Available model input files are located in subfolders \\conductors, \\magnets, and \\circuits. In this example, the model located in \\magnets\\MBRD\\input\\ will be built.\n- Add your personal settings file: you can start by copying/pasting the file settings\\user_settings\\settings.SYSTEM.yaml\n- Install the Python package steam-sdk (https://pypi.org/project/steam-sdk/)\n - If you know how to install a Python package, go for it!\n - If you don't know, you can run these code lines in a notebook cell\n```ruby\nimport sys\n!{sys.executable} -m pip install --user --upgrade steam-sdk\n```\n- Open the notebook STEAM_Library_withoutWidgets.ipynb (recommended using Jupyter or SWAN)\n- Edit the values of the following inputs according to wishes:\n```ruby\ncase_model: str = 'magnet'\nmodel_name: str = 'MBRD'\nsoftware: str = 'LEDET'\nflagBuild: bool = True\nverbose: bool = False\nflag_plot_all: bool = True\n```\n- Run the cell. The code will generate a LEDET model in the folder \\magnets\\MBRD\\output\\.\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Models for APIs for STEAM tools.",
"version": "2023.11.0",
"project_urls": {
"Homepage": "https://gitlab.cern.ch/steam/steam_models"
},
"split_keywords": [
"steam",
"simulation",
"models",
"cern"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f8927415afd6ec6d9f4dec1d721f434b66c11d4b733a1dd1e983fd12097f7156",
"md5": "0a52a394e216cf6cb691177e245272fa",
"sha256": "e912a93dacee782b7ca31277a2e990df4899a75fce2d838200d2cb947504039b"
},
"downloads": -1,
"filename": "steam_models-2023.11.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0a52a394e216cf6cb691177e245272fa",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 2022,
"upload_time": "2023-11-20T15:22:24",
"upload_time_iso_8601": "2023-11-20T15:22:24.214782Z",
"url": "https://files.pythonhosted.org/packages/f8/92/7415afd6ec6d9f4dec1d721f434b66c11d4b733a1dd1e983fd12097f7156/steam_models-2023.11.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ed4e648732132e4f6c9672d86395ac5033284c78756add97770925d01a432101",
"md5": "44f73a76fc157ce3c4dabd93593d733a",
"sha256": "c1a1934a840e2717d23a151344c953f0bde1c109bfc08e88b890935ba8229e63"
},
"downloads": -1,
"filename": "steam-models-2023.11.0.tar.gz",
"has_sig": false,
"md5_digest": "44f73a76fc157ce3c4dabd93593d733a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 88594975,
"upload_time": "2023-11-20T15:27:58",
"upload_time_iso_8601": "2023-11-20T15:27:58.485431Z",
"url": "https://files.pythonhosted.org/packages/ed/4e/648732132e4f6c9672d86395ac5033284c78756add97770925d01a432101/steam-models-2023.11.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-20 15:27:58",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "steam-models"
}
JSON