Data

Tools

Indexes

Applications

Experiments

Open Source Science

virtuallab

https://github.com/tokalab/virtuallab

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 (10.3%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: TokaLab
  • License: bsd-3-clause
  • Language: MATLAB
  • Default Branch: main
  • Size: 5.86 MB
Statistics
  • Stars: 2
  • Watchers: 0
  • Forks: 0
  • Open Issues: 0
  • Releases: 1
Created 9 months ago · Last pushed 7 months ago
Metadata Files
Readme License Citation

README.md

VirtualLab: Integrated Simulation and Diagnostics Playground

Welcome to VirtualLab, the example and demonstration environment of TokaLab. VirtualLab provides hands-on examples that integrate SimPla (Simulated Plasma Repository) and SynDiag (Synthetic Diagnostics) to form a complete virtual experimental setup. Users can simulate plasma equilibria and compute corresponding diagnostic signals in a seamless workflow.

🔬 Overview

VirtualLab is designed to:

  • Demonstrate realistic workflows using SimPla and SynDiag
  • Offer ready-to-run examples of equilibrium reconstruction + synthetic diagnostics
  • Provide templates for new experiments and simulation chains

It serves as an educational and research-oriented sandbox to prototype virtual tokamak scenarios. VirtualLab is especially useful in:

  • Educational environments
  • Thesis projects
  • Digital twin simulations of tokamaks

🗂 Repository Structure

plaintext VirtualLab/ │ ├── VirtualLab_MATLAB/ # MATLAB implementation (object-oriented) │ ├── ... │ │── VirtualLab_MATLAB_edu/ # MATLAB function-oriented code for education │ ├── ... │ ├── VirtualLab_Python/ # Python implementation (object-oriented) │ └── ... │ ├── docs/ # Coming soon! │ ├── License └── README.md

🔄 Workflow

A typical VirtualLab workflow consists of:

  1. Define separatrix and compute plasma equilibrium using SimPla
  2. Generate synthetic diagnostics using SynDiag
  3. Visualize and interpret results

🤖 Getting Started

  1. Ensure SimPla and SynDiag are downloaded in the proper folders VirtualLabMATLAB/SimPlaMATLAB and VirtualLabMATLAB/SynDiagMATLAB (or VirtualLabPython/SimPlaPython and VirtualLabPython/SynDiagPython)
  2. Navigate to a case study under examples/
  3. Run the provided script in Python or MATLAB

🤝 Contributing

We welcome contributions from the community. To contribute, please contact us.

📄 License

Tokalab is licensed under the BSD 3-Clause License.
Please see the License file for full details.

📬 Contact

For questions, suggestions, or collaborations:

TokaLab Team Email: [tokalab.fusion@gmail.com](mailto:tokalab.fusion@gmail.com) Website: [tokalab.github.io](https://tokalab.github.io/)

Happy experimenting in the VirtualLab!

Owner

  • Name: TokaLab
  • Login: TokaLab
  • Kind: organization

Citation (Citations.md) 

# Cite TokaLab

If you use TokaLab for your work, you can cite it as: 

TokaLab - An Open Access Virtual Tokamak for Education and Research (https://github.com/TokaLab)

# References and Libraries

## Libraries

The Python Module uses the following open-source libraries: 

- NumPy
Harris, C. R., Millman, K. J., van der Walt, S. J., Gommers, R., Virtanen, P., Cournapeau, D., ... & Oliphant, T. E. (2020). Array programming with NumPy. Nature, 585(7825), 357–362. https://doi.org/10.1038/s41586-020-2649-2

- SciPY
Virtanen, P., Gommers, R., Oliphant, T. E., Haberland, M., Reddy, T., Cournapeau, D., ... & van der Walt, S. J. (2020). SciPy 1.0: Fundamental algorithms for scientific computing in Python. Nature Methods, 17, 261–272. https://doi.org/10.1038/s41592-019-0686-2

- Matplotlib
Hunter, J. D. (2007). Matplotlib: A 2D graphics environment. Computing in Science & Engineering, 9(3), 90–95. https://doi.org/10.1109/MCSE.2007.55

- Python's standard libriaries
Python Software Foundation. Python Language Reference, version 3.x. Available at: https://www.python.org

The MATLAB Module has been developed using:
- MATLAB. (R2023). Version R2023b. Natick, Massachusetts: The MathWorks, Inc., https://www.mathworks.com 

## References

[1] Jardin, S. (2010). Computational Methods in Plasma Physics (1st ed.). CRC Press. https://doi.org/10.1201/EBK1439810958

[2] Jean, J. (2011). HELIOS: a zero-dimensional tool for next step and reactor studies. Fusion Science and Technology, 59(2), 308-349. https://doi.org/10.13182/FST11-A11650

[3] Coleman, M., & McIntosh, S. (2020). The design and optimisation of tokamak poloidal field systems in the BLUEPRINT framework. Fusion Engineering and Design, 154, 111544. https://doi.org/10.1016/j.fusengdes.2020.111544

GitHub Events

Total
  • Issues event: 2
  • Watch event: 3
  • Delete event: 1
  • Push event: 8
  • Public event: 1
  • Gollum event: 4
Last Year
  • Issues event: 2
  • Watch event: 3
  • Delete event: 1
  • Push event: 8
  • Public event: 1
  • Gollum event: 4