CHERAB-LHD

CI/CD
Docs
Package
Meta

---

This repository contains the Large Helical Device (LHD) machine-dependent extensions of cherab code. LHD is a helical magnetic confinement fusion device in the National Institute for Fusion Science (NIFS) in Japan.

Table of Contents

• Get Started
• Documentation
• License

Get Started

Task-based execution

We offer some tasks to execute programs in CLI. You can see the list of tasks using pixi command.

pixi task list

If you want to execute a task, you can use the following command.

pixi run <task_name>

Notebooks

We provide some notebooks to demonstrate the usage of the CHERAB-LHD code. To launch the Jupyter lab server, you can use the following command.

pixi run lab

Then, you can access the Jupyter lab server from your web browser.

Documentation

The documentation is made with Sphinx and hosted on Read the Docs. There are two versions of the documentation:

• Development
• Release

You can build the documentation locally by running the following command.

pixi run doc-build

License

cherab-lhd is distributed under the terms of the BSD-3-Clause license.