Skip to content

neutrinoceros/idefix_cli

Folders and files

NameName
Last commit message
Last commit date
Mar 1, 2025
Jan 1, 2025
Jan 20, 2025
Jan 20, 2025
Jul 29, 2023
Jan 6, 2025
Jan 1, 2025
Dec 31, 2024
Mar 13, 2021
Oct 26, 2024
Sep 1, 2024
Jan 20, 2025
Feb 10, 2025

Repository files navigation

PyPI Documentation Status pre-commit.ci status Ruff

idefix_cli

idefix_cli is a command line utility belt for 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 as

$ uv tool install idefix-cli

or pipx

$ pipx install idefix-cli

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

$ 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

$ idfx --help

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

$ idfx run --help

For more, read the documentation !