Crayon

Crayon is a ray tracing code for simulating the propagation and damping of microwaves in fusion relevant plasmas with a focus on electron Bernstein waves (EBWs).

Installation

See installation guide

Getting Started

See getting started.

Code of conduct

See code of conduct.

Contributing

See contributer guide.

Terms of Use

Crayon is released under the following license, but we also ask that you show professional courtesy when using this code:

1. Since you are benefiting from work on Crayon, we ask that you submit any improvements you make to the code to us by submitting a pull request to this repository. If you are looking to develop aspects of this code or add parts to it, please contact us beforehand so that we can help/advise if necessary.

2. If you use Crayon results in a paper or professional publication, we ask that you discuss your work and results with one of the Crayon authors first so that we can check them. It is not necessary to list Crayon developers as co-authors. If one or more of the Crayon team are involved in preparing results or new functionality used in your work, then those members should be offered a co-authorship.

3. If you use Crayon or any of its modules in your work, please help ensure that all the authors get the credit they deserve by citing the relevant Crayon papers.

For a full list of existing publications, see here.

Publications

The Crayon code and its modules are described in the following publications:

• Wilson T., et al (2025). 51th EPS Conference on Contr. Fusion and Plasma Phys