This release is a pre-release and may not be stable for production use.
Scotty
Beam tracing for tokamak DBS diagnostics
Scotty v3 and v4
Scotty v4 is at its first release candidate, 4.0.0rc1. It is the version on
the master branch. The rc freezes the interface (argument names and defaults,
what the inputs mean, the output variables), so scripts written for it should
keep working in 4.0.0; only fixes that leave the interface alone go in before
then. Some of v3's features haven't been ported yet. Until 4.0.0 is released,
v3 is the stable line: use it for published work, or anything you need to
reproduce later. Please try v4 and report problems at
https://github.com/beam-tracing/Scotty/issues.
- v3 (stable, the released version): beam tracing in cylindrical coordinates (R, ζ, Z). The latest release is 3.2.0.
- v4 (release candidate 4.0.0rc1): the same beam model,
with a choice of cylindrical or Cartesian (X, Y, Z) coordinates
(
geometry="cylindrical"or"cartesian"). Outputs are given in both. It has been checked against v3 on the test suite and on DIII-D, MAST-U and MAST cases. Its known differences from v3 (see the release notes in the documentation,docs/release_notes.rst):- some arguments and output names have changed.
scotty.compat.from_v3_kwargstranslates v3'sbeam_me_uparguments, andscotty.compat.quick_cutoffreplaces v3'squick_run; launch_flagreplaces v3'svacuumLaunch_flagandvacuum_propagation_flag:"vacuum_analytic"(analytic propagation to the plasma boundary, thenPsi_BC_flag; v3'svacuum_propagation_flag=True),"vacuum_numerical"(the solvers start at the antenna; v3'svacuum_propagation_flag=False) or"plasma";- a plasma launch (
launch_flag="plasma", v3'svacuumLaunch_flag=False) checks that the launch point is inside the plasma and that K satisfies the dispersion relation, and takes K and Ψ in Cartesian components. With no launched beam,filterfun_bandfilterfun_allare NaN; Psi_BC_flagis"continuous","discontinuous"orNone; v3's deprecatedTrueandFalseraise an error.Psi_BC_flag=None(v3's default) checks that the density is zero and flat at the plasma edge, and raises an error otherwise;- the localisation is called the filter function: v3's
loc_*are v4'sfilter_*; - the default spatial finite-difference step (
delta_R,delta_Z, ...) is 1e-5 (v3: 1e-4), the default solver tolerances arertol=1e-4,atol=1e-7(v3: 1e-3, 1e-6), and the defaultlen_tauis 4002 (v3: 102); - not yet ported: most of v3's matplotlib plots (
scotty.plottinghasplot_dispersion_relation,plot_poloidal_beam_pathandplot_toroidal_beam_path), the filter-function widths (delta_l,delta_kperp1), the GUI (GUI/scottypygui.py), and thecurvy_slabfield, which is deprecated; - check which version you have with
scotty.__version__. An install frommasterafter the rc gives a development version such as4.0.0rc2.dev5+g1234abc(fromsetuptools_scm).
- some arguments and output names have changed.
Install
The package to install is called scotty-beam-tracing, but the Python module is
just scotty.
v3 (stable). From PyPI:
pip install scotty-beam-tracing
or a specific release straight from GitHub:
pip install git+https://github.com/beam-tracing/Scotty@v3.2.0
v4 (release candidate). From PyPI (pip installs release candidates only when asked to):
pip install scotty-beam-tracing==4.0.0rc1
or the latest development version, straight from GitHub:
pip install git+https://github.com/beam-tracing/Scotty
or from a local clone:
pip install .
when developing, use:
pip install -e .
Documentation
https://scotty.readthedocs.io/
Background
Description of the Scotty [1], derivation of beam tracing given in Appendix A.
References
[1] Hall-Chen, V. H., Parra, F. I., & Hillesheim, J. C. (2022). Beam model of Doppler backscattering. Plasma Physics and Controlled Fusion, 64(9), 095002.
Metadata
Release files for scotty-beam-tracing 4.0.0rc1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| scotty_beam_tracing-4.0.0rc1.tar.gz | 991.8 kB | Without provenance | Details for scotty_beam_tracing-4.0.0rc1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| scotty_beam_tracing-4.0.0rc1-py3-none-any.whl | Python 3 | none | any | Details for scotty_beam_tracing-4.0.0rc1-py3-none-any.whl |
Total release size: 1.2 MB
Release files / scotty_beam_tracing-4.0.0rc1.tar.gz
| Download URL | scotty_beam_tracing-4.0.0rc1.tar.gz |
|---|---|
| Size | 991.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
407b25a94511868e9826e6851a6e8575b5db0877679febe8d229ce3171e62981
|
|
BLAKE2b-256 checksum How to use checksums |
0f60aaa6fe1754a1f74e1bf4375aa94094ac8d285db8f618307cb4b16b3515e3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Release files / scotty_beam_tracing-4.0.0rc1-py3-none-any.whl
| Download URL | scotty_beam_tracing-4.0.0rc1-py3-none-any.whl |
|---|---|
| Size | 171.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
35d552a0350de4618356280ad053c9dbb1092aea1efbf1c7c773f2bfae057a53
|
|
BLAKE2b-256 checksum How to use checksums |
b222ed0738db43b8915d8bffaa2c68eccb65fbb9104452255e918ad235899d9d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Security for scotty-beam-tracing 4.0.0rc1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.