Metadata-Version: 2.1
Name: fiqus
Version: 2026.1.0
Summary: Source code for STEAM FiQuS tool
Home-page: https://gitlab.cern.ch/steam/fiqus
Author: STEAM Team
Author-email: steam-team@cern.ch
Keywords: STEAM,FiQuS,CERN
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: gmsh==4.13.1
Requires-Dist: h5py==3.10.0
Requires-Dist: Jinja2==3.1.3
Requires-Dist: matplotlib==3.8.3
Requires-Dist: mplcursors==0.5.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: ruamel.yaml.clib==0.2.8
Requires-Dist: scipy==1.14.1
Requires-Dist: tqdm==4.66.2
Requires-Dist: typing_extensions==4.10.0
Provides-Extra: all
Requires-Dist: gmsh==4.13.1; extra == "all"
Requires-Dist: h5py==3.10.0; extra == "all"
Requires-Dist: Jinja2==3.1.3; extra == "all"
Requires-Dist: matplotlib==3.8.3; extra == "all"
Requires-Dist: mplcursors==0.5.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: ruamel.yaml.clib==0.2.8; extra == "all"
Requires-Dist: scipy==1.14.1; extra == "all"
Requires-Dist: tqdm==4.66.2; extra == "all"
Requires-Dist: typing_extensions==4.10.0; extra == "all"
Requires-Dist: griffe==0.42.0; extra == "all"
Requires-Dist: markdown==3.5.2; extra == "all"
Requires-Dist: markdown-include==0.8.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: mkdocstrings-python==1.9.0; extra == "all"
Requires-Dist: mkdocs-autorefs==1.3.1; extra == "all"
Requires-Dist: coverage==7.4.4; extra == "all"
Requires-Dist: coverage-badge==1.1.0; extra == "all"
Requires-Dist: flake8==7.0.0; extra == "all"
Requires-Dist: mypy==1.9.0; extra == "all"
Requires-Dist: pylint==3.1.0; extra == "all"
Requires-Dist: pytest==8.1.1; extra == "all"
Requires-Dist: pytest-cov==4.1.0; extra == "all"
Requires-Dist: pytest-subtests==0.12.1; extra == "all"
Requires-Dist: setuptools==69.2.0; extra == "all"
Requires-Dist: wheel==0.45.1; extra == "all"
Requires-Dist: twine==6.0.1; extra == "all"
Provides-Extra: docs
Requires-Dist: griffe==0.42.0; extra == "docs"
Requires-Dist: markdown==3.5.2; extra == "docs"
Requires-Dist: markdown-include==0.8.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: mkdocstrings-python==1.9.0; extra == "docs"
Requires-Dist: mkdocs-autorefs==1.3.1; extra == "docs"
Provides-Extra: tests
Requires-Dist: coverage==7.4.4; extra == "tests"
Requires-Dist: coverage-badge==1.1.0; extra == "tests"
Requires-Dist: flake8==7.0.0; extra == "tests"
Requires-Dist: mypy==1.9.0; extra == "tests"
Requires-Dist: pylint==3.1.0; extra == "tests"
Requires-Dist: pytest==8.1.1; extra == "tests"
Requires-Dist: pytest-cov==4.1.0; extra == "tests"
Requires-Dist: pytest-subtests==0.12.1; extra == "tests"
Provides-Extra: build
Requires-Dist: setuptools==69.2.0; extra == "build"
Requires-Dist: wheel==0.45.1; extra == "build"
Requires-Dist: twine==6.0.1; extra == "build"

![FiQuS logo](https://gitlab.cern.ch/steam/fiqus/-/raw/master/docs/images/FiQuS_name_logo.svg)

# Introduction
Source code for STEAM **FiQuS** (**Fi**nite Element **Qu**ench **S**imulator).

# Publications

## Describing FiQuS Modules
- S. Atalay et al, "An open-source 3D FE quench simulation tool for no-insulation HTS pancake coils", in Superconductor Science and Technology, doi: [10.1088/1361-6668/ad3f83](https://doi.org/10.1088/1361-6668/ad3f83)
- J. Dular et al, "Coupled Axial and Transverse Currents Method for Finite Element Modelling of Periodic Superconductors", in Superconductor Science and Technology, doi: [10.1088/1361-6668/ad650d](https://doi.org/10.1088/1361-6668/ad650d).
- E. Schnaubelt et al, "Transient Finite Element Simulation of Accelerator Magnets Using Thermal Thin Shell Approximation", arXiV preprint, doi: [10.48550/arXiv.2501.15871](https://doi.org/10.48550/arXiv.2501.15871).
- A. Vitrano et al, "An Open-Source Finite Element Quench Simulation Tool for Superconducting Magnets," in IEEE Transactions on Applied Superconductivity, vol. 33, no. 5, pp. 1-6, Aug. 2023, Art no. 4702006, doi: [10.1109/TASC.2023.3259332](https://ieeexplore.ieee.org/abstract/document/10077402).
- J. Dular et al, "Simulation of Rutherford Cable AC Loss and Magnetization with the Coupled Axial and Transverse Currents Method", in IEEE Transactions on Applied Superconductivity, [10.1109/TASC.2024.3520941](https://doi.org/10.1109/TASC.2024.3520941).
- J. Dular et al, "Distributed Inter-Strand Coupling Current Model for Finite Element Simulations of Rutherford Cables", arXiv preprint, doi: [arXiv:2510.24618](https://arxiv.org/abs/2510.24618).

## Using FiQuS
- M. Wozniak et al, "Influence of Critical Current Distribution on Operation, Quench Detection and Protection of HTS Pancake Coils, in IEEE Transactions on Applied Superconductivity, [10.1109/TASC.2025.3532246](https://doi.org/10.1109/TASC.2025.3532246).
- Laura AM Dâ€™Angelo et al, "Efficient Reduced Magnetic Vector Potential Formulation for the Magnetic Field Simulation of Accelerator Magnets", in IEEE Transactions on Magnetics, vol. 60, no. 3, pp. 1-8, Jan. 2024, Art no. 7000808, doi: [10.1109/TMAG.2024.3352113](https://ieeexplore.ieee.org/abstract/document/10387412).
- M. Wozniak et al, "Quench Co-Simulation of Canted Cos-Theta Magnets," in IEEE Transactions on Applied Superconductivity, vol. 34, no. 3, pp. 1-5, Dec. 2023, Art no. 4900105, doi: [10.1109/TASC.2023.3338142](https://ieeexplore.ieee.org/document/10337614).
- M. Wozniak et al, "Fast Quench Propagation Conductor for Protecting Canted Cos-Theta Magnets," in IEEE Transactions on Applied Superconductivity, vol. 33, no. 5, pp. 1-5, Aug. 2023, Art no. 4701705, doi: [10.1109/TASC.2023.3247997](https://ieeexplore.ieee.org/document/10050158).
- E. Schnaubelt et al, "Parallel-in-Time Integration of Transient Phenomena in No-Insulation Superconducting Coils Using Parareal", accepted for publication in the proceedings of the 
Scientific Computing in Electrical Engineering (SCEE) 2024 conference, [arXiv:2404.13333](https://arxiv.org/abs/2404.13333).

## Mathematical Formulations Forming the Basis of Some FiQuS Modules
- E. Schnaubelt et al, "Magneto-Thermal Thin Shell Approximation for 3D Finite Element Analysis of No-Insulation Coils", in IEEE Transactions on Applied Superconductivity, vol. 34, no. 3, pp. 1-6, Dec. 2023, Art no. 4700406, doi: [10.1109/TASC.2023.3340648](https://ieeexplore.ieee.org/document/10349801).
- E. Schnaubelt et al, "Electromagnetic Simulation of No-Insulation Coils Using Hâˆ’Ï† Thin Shell Approximation", in IEEE Transactions on Applied Superconductivity, vol. 33, no. 5, pp. 1-6, Mar. 2023, Art no. 4900906, doi: [10.1109/TASC.2023.3258905](https://ieeexplore.ieee.org/document/10076826).
- E. Schnaubelt et al, "Thermal thin shell approximation towards finite element quench simulation", in Superconductor Science and Technology, vol. 36, no. 4, Art no. 044004, doi: [10.1088/1361-6668/acbeea](https://iopscience.iop.org/article/10.1088/1361-6668/acbeea).
- J. Dular et al, "Reduced order hysteretic magnetization model for composite superconductors", in Superconductor Science and Technology, vol. 38, no. 3, Art no. 035017, doi: [10.1088/1361-6668/adb5cc](https://iopscience.iop.org/article/10.1088/1361-6668/adb5cc/meta).
- J. Dular et al, "A Finite Element a-h-Formulation for the Reduced Order Hysteretic Magnetization Model for Composite Superconductors", in IEEE Transactions on Applied Superconductivity, vol. 35, no. 5, Art no. 8200205, doi: [10.1109/TASC.2025.3528310](https://ieeexplore.ieee.org/abstract/document/10839043).
- A. Glock et al, "Reduced Order Hysteretic Flux Model for Transport Current Homogenization in Composite Superconductors", in IEEE Transactions on Magnetics, doi: [10.1109/TMAG.2025.3613877](https://ieeexplore.ieee.org/abstract/document/11177605).

# Folder Structure
![FiQuS folder structure](https://gitlab.cern.ch/steam/fiqus/-/raw/master/docs/images/FiQuS_folder_structure.svg)

# Installation

## Released version:
```pip install fiqus```

# Links
STEAM website: http://cern.ch/steam

STEAM-FiQuS website: https://steam.docs.cern.ch/tools/fiqus/

STEAM-FiQuS documentation: https://steam-fiqus.docs.cern.ch/ 

Coverage report: https://steam-fiqus.docs.cern.ch/htmlcov/ 

# Contact
steam-admins@cern.ch

# License
This project is licensed under the GNU General Public License v3.0. See the LICENSE file for details.

(Copyright Â© 2022, CERN, Switzerland. All rights reserved.)
