stok
A tool for parametric generation of simple rectangular tokamaks.
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.7%) to scientific vocabulary
Repository
A tool for parametric generation of simple rectangular tokamaks.
Basic Info
- Host: GitHub
- Owner: A-Gabrijel
- License: mit
- Language: Python
- Default Branch: main
- Size: 17.7 MB
Statistics
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
- Releases: 2
Metadata Files
README.md
STOK - Simple TOKamak generator
A tool for parametric generation of simple tokamaks with rectangular cross-section.
Authors: Anže Gabrijel, Aljaž Čufar
DESCRIPTION
STOK is an attempt to solve long model development times in fusion. The code is meant to create relatively simple simulation models for Monte Carlo simulations, e.g. .stl files for use in Serpent 2. It is meant to be a sort of a book of receipts for reactor components that the user can either use or omit when creating a model that is tailored to their needs. It is completely parametric, meaning that no building block is fixed; all of them can be changed with one or more parameters. Once its parameters are specified STOK draws a specified component, which can then be exported into various CAD (Computer Aided Design) formats for further use.
STOK is completely based on CadQuery and returns CadQuery objects, so every object can be further modified with it.
For exporting .stl files CadQuery was found to produce leaky meshes, so we opted to use pygmsh which is a meshing tool that is better suited for creating meshes than CadQuery.
Initial internal development of STOK perdates the public release of Paramak but this released version also draws some inspiration from it as some of the underlying workflow is similar. In our oppinion even with future updates STOK should remain in the domain of very simple reactor models while users requiring more realistic models should use Paramak.
INSTALLATION AND DEPENDENCIES
Installing STOK can be done through pip in the following way:
bash
pip install git+https://github.com/A-Gabrijel/STOK@<branch-or-tag>
For example, to install directly from master the syntax would be:
bash
pip install git+https://github.com/A-Gabrijel/STOK@main
ACKNOWLEDGEMENTS
The authors acknowledge the financial support from the Slovenian Research an Innovation Agency (research project Z2-3201, research program No. P2-0073).
Owner
- Name: Anže Gabrijel
- Login: A-Gabrijel
- Kind: user
- Repositories: 1
- Profile: https://github.com/A-Gabrijel
Electrical engineering student at the University of Ljubljana Currently working for @ijs-f8 on automating fusion reactor design
Citation (CITATION.cff)
cff-version: 1.2.0 message: "If you use this software, please cite it as below." authors: - family-names: "Gabrijel" given-names: "Anže" orcid: "https://orcid.org/0009-0004-7544-0016" title: "STOK" version: 1.0.0 date-released: 2022-08-30 url: "https://github.com/A-Gabrijel/STOK"
GitHub Events
Total
Last Year
Dependencies
- pytest ^6.2.4 develop
- cadquery ^2.1
- gmsh ^4.8
- python ^3.8