Contributing to TORAX

How to contribute

We’d love to accept your contributions to this project. There are multiple ways to contribute:

• Answering questions on TORAX’s [discussions page].

• Improving TORAX’s [documentation].

• Contributing to TORAX’s core [code-base].

A wide variety of contributions are welcome. See the Development Roadmap for prioritized projects. In particular, TORAX is envisaged as a natural framework for coupling of various ML-surrogates of physics models. These could include surrogates for turbulent transport, neoclassical transport, heat and particle sources, line radiation, pedestal physics, and core-edge integration, MHD, among others. Before making major contributions please begin a discussion on the repo to ensure that the feature is not already in development, and to discuss ideas and design before starting work.

See Contribution tips for more guidance on installation, code review, documentation, and testing.

Before you begin

Sign our Contributor License Agreement

Contributions to this project must be accompanied by a [Contributor License Agreement] (CLA).

If you or your current employer have already signed the Google CLA (even if it was for a different project), you probably don’t need to do it again.

Visit https://cla.developers.google.com to see your current agreements or to sign a new one.

Review our community guidelines

This project follows [Google’s Open Source Community Guidelines].