https://github.com/neutrinoceros/idefix_cli

A command line utility belt for Idefix
https://github.com/neutrinoceros/idefix_cli

command-line gpu hpc magnetohydrodynamics user-experience

Last synced: about 6 hours ago
JSON representation

A command line utility belt for Idefix

• Host: GitHub
• URL: https://github.com/neutrinoceros/idefix_cli
• Owner: neutrinoceros
• License: gpl-3.0
• Created: 2021-03-13T07:09:06.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-08T16:54:03.000Z (2 months ago)
• Last Synced: 2024-09-08T18:41:52.178Z (2 months ago)
• Topics: command-line, gpu, hpc, magnetohydrodynamics, user-experience
• Language: Python
• Homepage: https://idefix-cli.readthedocs.io/en/latest/
• Size: 600 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: docs/contributing.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![PyPI](https://img.shields.io/pypi/v/idefix_cli.svg?logo=pypi&logoColor=white&label=PyPI)](https://pypi.org/project/idefix-cli/)

[![Documentation Status](https://readthedocs.org/projects/idefix-cli/badge/?version=latest)](https://idefix-cli.readthedocs.io/en/latest/?badge=latest)

[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/neutrinoceros/idefix_cli/main.svg)](https://results.pre-commit.ci/badge/github/neutrinoceros/idefix_cli/main.svg)

[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/charliermarsh/ruff)

# `idefix_cli`

`idefix_cli` is a command line utility belt for [Idefix](https://github.com/idefix-code/idefix).

It defines a `idfx` command familly. The builtin command set (`idfx conf`, `idfx run`,

...) can be extended to include arbitrary helper scripts.

## Installation

`idefix_cli` is distributed via the Python Packaging Index (PyPI).

It is recommended to install this tool at the system level, but still in isolation,

using for instance [`uv`](https://docs.astral.sh/uv/) as

```shell

$ uv tool install idefix-cli

```

or [`pipx`](https://pipxproject.github.io/pipx/)

```shell

$ pipx install idefix-cli

```

Otherwise, the most portable way to install the latest stable version is

```shell

$ python -m pip install --user idefix_cli

```

Note that most `idfx` commands explicitly require that the env variable `$IDEFIX_DIR` be

set at runtime.

## Get help

Get a complete description of available commands with

```shell

$ idfx --help

```

Likewise, get help for each command therein as, for instance

```shell

$ idfx run --help

```

For more, read [the documentation !](https://idefix-cli.readthedocs.io/en/latest/?badge=latest)