Skip to content

PlasmaControl/TokEye

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

TokEye Logo

TokEye

(This repository is a work in progress. Please check back for updates or reach out to [email protected].)

TokEye is a open-source Python-based application for automatic classification and localization of fluctuating signals. It is designed to be used in the context of plasma physics, but can be used for any type of fluctuating signal.

Check out this poster from APS DPP 2025 for more information.

Example Demonstration

Example Demonstration

Expected processing time:

  • A100: < 0.5 seconds on any size spectrogram after warmup.
  • CPU: not yet tested.

Verified Datatypes

  • DIII-D Fast Magnetics (cite)
  • DIII-D CO2 Interferometer (cite)
  • DIII-D Electron Cyclotron Emission (cite)
  • DIII-D Beam Emission Spectroscopy (cite)

With more data, comes better models. Please contribute to the project!

Installation

uv (recommended)

git clone [email protected]:PlasmaControl/TokEye.git
cd TokEye
uv sync

pip (from source)

git clone [email protected]:PlasmaControl/TokEye.git
cd TokEye
python3 -m venv .venv
source venv/bin/activate
pip install uv
uv sync

pip (from PyPI)

pip install tokeye

Coming soon.

Containerized installation (Docker) Coming soon.

Usage

python -m TokEye.app

This will start a web app on http://localhost:8888.

If you are on a remote server, you can use SSH port forwarding to access the web app on your local machine:

ssh -L 8888:localhost:7860 user@remote_server

Then open your web browser and navigate to http://localhost:8888.

Models

Pre-trained models are available at this link. Copy them into the models/ directory after downloading them.

Data

Right now, keep all data as 1d numpy float arrays. No need to normalize or preprocess them. Copy them into the data/ directory.

Citation

If you use this code in your research, please cite:

@article{NaN,
  title={Paper not yet published},
  author={Nathaniel Chen},
  year={2025}
}

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages