-
Notifications
You must be signed in to change notification settings - Fork 5
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update README with the doi of the article OPENSC2.
- Loading branch information
1 parent
a98e7b9
commit f2694be
Showing
1 changed file
with
24 additions
and
16 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,36 +1,43 @@ | ||
| # OPENSC2 in a nutshell | ||
| # OPENSC2 | ||
|
|
||
| Object-oriented software for multiphysics simulations of Superconducting cables. | ||
| ## OPENSC2 in a nutshell | ||
|
|
||
| ## Features | ||
| Object-oriented software for multiphysics simulations of Superconducting cables. | ||
|
|
||
| ### Features | ||
|
|
||
| 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. | ||
|
|
||
| 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. | ||
| 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. | ||
|
|
||
| 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. | ||
| 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: | ||
| 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: | ||
|
|
||
| * [email protected] | ||
| * [email protected] | ||
| * [email protected] | ||
| * [email protected] | ||
| * [email protected] | ||
| * [email protected]. | ||
|
|
||
| [^1]: Head of the [**MAHTEP** research group](http://www.mahtep.polito.it/). | ||
| [^2]: PhD students @ the [**MAHTEP** research group](http://www.mahtep.polito.it/). | ||
| ## Goals | ||
|
|
||
| ### Goals | ||
|
|
||
| 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. | ||
|
|
||
| # Get started | ||
| 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). | ||
|
|
||
| ## Get started | ||
|
|
||
| Users can benefit from several test cases to check the software functionalities: | ||
|
|
||
| 1. Heat slug propagation in an ITER TF-like CICC | ||
| 2. Heat slug propagation in a stacked-HTS slotted-core CICC for fusion applications | ||
| 3. Steady state operation for a double-cryostat HVDC cable for power transmission | ||
|
|
||
| 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. | ||
|
|
||
| ## Install requirements | ||
| ### Install requirements | ||
|
|
||
| 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: | ||
|
|
||
|
|
@@ -39,21 +46,22 @@ The selected Python version is [3.8.10](https://www.python.org/downloads/release | |
|
|
||
| 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). | ||
|
|
||
| # Help | ||
| ## Help | ||
|
|
||
| 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. | ||
| For the time being feel free to send an e-mail to [email protected] if you need any help with your simulations. | ||
| 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). | ||
| The development team apologizes for the inconvenience and is committed to fixing them as soon as possible. | ||
|
|
||
| # Contribution | ||
| ## Contribution | ||
|
|
||
| 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. | ||
| To contribute please refer to [contribution](CONTRIBUTION.md). | ||
|
|
||
| # Code of Conduct | ||
| ## Code of Conduct | ||
|
|
||
| The developing team agreed to embrace the [](CODE_OF_CONDUCT.md) **Code of Conduct**. | ||
|
|
||
| # License | ||
| OPENSC2 is licensed under [](LICENSE) or any other version of it. | ||
|
|
||
| ## License | ||
|
|
||
| OPENSC2 is licensed under [](LICENSE) or any other version of it. | ||