Skip to content

munechika-koyo/cherab_lhd

Repository files navigation

CHERAB-LHD

CI/CD pre-commit.ci status PyPI Publish
Docs Documentation Status
Package PyPI - Version Conda PyPI - Python Version
Meta DOI License - BSD3 Pixi Badge

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

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-NAGDIS 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 currently under preparation.

License

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