search

beam-tracing / Scotty

Beam tracing code for diagnostics
https://scotty.readthedocs.io/en/latest/
GNU General Public License v3.0
7 stars 4 forks source link

Update README.md 👇🏻 #97

Closed ripgamer closed 1 year ago

ripgamer commented 1 year ago

Hello there! 👋 Welcome to Scotty!

🌌 Scotty

Scotty is a Python package for beam tracing in tokamak Doppler backscattering (DBS) diagnostics. It provides a set of tools for simulating and analyzing DBS signals in tokamak plasmas.

🚀 Installation

Scotty can be installed using pip:

pip install scotty-beam-tracing

Note that the package to install is called scotty-beam-tracing, but the Python module is just scotty.

To install the development version of scotty straight from GitHub:

pip install git+https://github.com/beam-tracing/Scotty

or from a local clone:

pip install .

📖 Usage

To use Scotty, you first need to import the scotty module:

import scotty

Then you can use its functions to simulate DBS signals.

For more information on how to use Scotty, see the 📚 documentation:

📄 License

Scotty is licensed under the MIT License. See the LICENSE.md file for more information.

Made with ❤️ and ☕️ by the Scotty team.

valerian-chen commented 1 year ago

Unidentified spam