You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Object-oriented software for multiphysics simulations of Superconducting cables.
3
+
## OPENSC2 in a nutshell
4
4
5
-
## Features
5
+
Object-oriented software for multiphysics simulations of Superconducting cables.
6
+
7
+
### Features
6
8
7
9
OPENSC2 is a software for the multi-physical analysis of thermal-hydraulic and electro-dynamic transients in Superconducting Cable-in-Conduit Conductors (CICC) for fusion magnets and power transmission.
8
10
9
-
Currently it is developed mainly in [Python](https://www.python.org/) but future versions will possibly take advantage of other programming languages such as [TypeScript](https://www.typescriptlang.org/) and [Rust](https://www.rust-lang.org/) as well as the [OpenModelica](https://www.openmodelica.org/) environment.
11
+
Currently it is developed mainly in [Python](https://www.python.org/) but future versions will possibly take advantage of other programming languages such as [TypeScript](https://www.typescriptlang.org/) and [Rust](https://www.rust-lang.org/) as well as the [OpenModelica](https://www.openmodelica.org/) environment.
10
12
11
13
The software is built based on well-established numerical models and assumptions, re-arranged in an object-oriented framework to be user-friendly and easily manageable through a GUI. The input set is to be prescribed through self-explanatory excel files.
12
-
The developing team includes Prof. L. Savoldi[^1], Prof. F. Freschi, D. Placido[^2], S. Viarengo[^2] @ Dipartimento Energia “Galileo Ferraris” @ [Politecnico di Torino](https://www.polito.it/). Please, contact us at:
14
+
The developing team includes Prof. L. Savoldi[^1], Prof. F. Freschi, D. Placido[^2], S. Viarengo[^2] @ Dipartimento Energia “Galileo Ferraris” @ [Politecnico di Torino](https://www.polito.it/). Please, contact us at:
15
+
13
16
*laura.savoldi@polito.it
14
-
*fabio.freschi@polito.it
15
-
*daniele.placido@polito.it
17
+
*fabio.freschi@polito.it
18
+
*daniele.placido@polito.it
16
19
*sofia.viarengo@polito.it.
17
20
18
21
[^1]: Head of the [**MAHTEP** research group](http://www.mahtep.polito.it/).
19
22
[^2]: PhD students @ the [**MAHTEP** research group](http://www.mahtep.polito.it/).
20
-
## Goals
23
+
24
+
### Goals
21
25
22
26
The software is useful for steady state and transient analyses of CICC in operating conditions. It can deal with cables assemled with Low Temperatures (LTS) strands (both Nb3Sn and NbTi), and High Temperature Superconductors (HTS) tapes of different materials. Different coolants can be selected, together with very different cooling configurations. The software is useful to study the steady state operating conditions under environmental parasitic load, as well as transient operation such as: current variation in time, coolant flow variation in time, AC losses, quench, fast discharges, fault currents. The software is useful to assist the research for optimal configurations, subject to a set of constraints, and allows evaluating the temperature margin to current sharing along cables in any pre-defined operating scenarios.
23
27
24
-
# Get started
28
+
A detailed description of the physics and of the first tests carried out for the initial phase of verification and validation of the software is available [here](https://doi.org/10.1016/j.cryogenics.2022.103457).
29
+
30
+
## Get started
25
31
26
32
Users can benefit from several test cases to check the software functionalities:
33
+
27
34
1. Heat slug propagation in an ITER TF-like CICC
28
35
2. Heat slug propagation in a stacked-HTS slotted-core CICC for fusion applications
29
36
3. Steady state operation for a double-cryostat HVDC cable for power transmission
30
37
31
38
To run a simulation with one of the above test cases, download the repository and install the requirements (more informations in section [Install requirements](user-content-intall-requirements)). After that, you can run the software (the starting file is _simulation_starter.py_) and from the GUI you can navigate through the folder three until you enter directory _TDD_examples_ and then select one of the three folders contained with pre-compiled inpuput files. In the GUI window select **Add solution path** to select where to save the results (by default they are all collected in the directory _Simulation_results_, that is automatically created if does not already exist). User can create a new folder in this directory or open an existing one: the output (both .tsv files and .eps figures) will be saved in this folder.
32
39
33
-
## Install requirements
40
+
###Install requirements
34
41
35
42
The selected Python version is [3.8.10](https://www.python.org/downloads/release/python-3810/). To install the requirements, create a virtual environment (suggested name _opensc2_) and activate it. In your terminal run the following command:
36
43
@@ -39,21 +46,22 @@ The selected Python version is [3.8.10](https://www.python.org/downloads/release
39
46
40
47
Among the dependences there is [CoolProp](http://www.coolprop.org/) that, according to the operative system you use, may require some other dependences and/or packages. To deal with this, please follow the [documentation](http://www.coolprop.org/coolprop/wrappers/Python/index.html) and [prerequisites](http://www.coolprop.org/coolprop/wrappers/index.html#wrapper-common-prereqs).
41
48
42
-
# Help
49
+
##Help
43
50
44
51
Software documentation is under development, being the project at its initial stages. Detailed documentation will be provided as soon as an established version of the software is available.
45
52
For the time being feel free to send an e-mail to daniele.placido@polito.it if you need any help with your simulations.
46
53
Being currently an embryonic software, some of the possibilities provided in the input files may not yet be fully implemented or tested and you may get incorrect results or unexpected errors. A (not exhaustive) list of known issues is available in the [Issue](https://github.com/MAHTEP/OPENSC2/issues) section. To open a new issue, please [follow the procedure](https://github.com/MAHTEP/OPENSC2/blob/main/CONTRIBUTION.md).
47
54
The development team apologizes for the inconvenience and is committed to fixing them as soon as possible.
48
55
49
-
# Contribution
56
+
##Contribution
50
57
51
58
The developing team wish to receive help form the users in the definition and test of new test cases, in the benchmark against other established software, in the inclusion of other functionalities.
52
59
To contribute please refer to [contribution](CONTRIBUTION.md).
53
60
54
-
# Code of Conduct
61
+
##Code of Conduct
55
62
56
63
The developing team agreed to embrace the [](CODE_OF_CONDUCT.md)**Code of Conduct**.
57
-
58
-
# License
59
-
OPENSC2 is licensed under [](LICENSE) or any other version of it.
64
+
65
+
## License
66
+
67
+
OPENSC2 is licensed under [](LICENSE) or any other version of it.
0 commit comments