Command Line Interface

Overview

MapLine provides a command-line interface (CLI) to perform emission-line fitting directly from the terminal. The CLI allows users to run the full analysis workflow without writing Python scripts.

The main entry point is:

run_mapline

Two main commands are available:

• run — perform emission-line fitting on IFU cubes

• runoned — fit emission lines in a single spectrum

run_mapline --help
run_mapline run --help
run_mapline runoned --help

These commands internally call the fitting routines implemented in MapLines.tools.line_fit.

CLI reference

run_mapline

CLI for the emission line mapper

Usage

run_mapline [OPTIONS] COMMAND [ARGS]...

run

Run the emission line mapper

Usage

run_mapline run [OPTIONS]

Options

-g, --config_file <config_file>

name of the config file

-n, --name <name>

name of the IFS cube

-o, --name_out <name_out>

name of the output files

-m, --mask <mask>

name of the mask map

-p, --path <path>

path to the data cubes

-y, --path_out <path_out>

path of the output files

-c, --ncpus <ncpus>

number of CPUs

-k, --kskew

flag to run skew line profile mode

-x, --outflow

flag to run outflow line profile mode

-t, --test

flag to run the full analysis

-e, --error

flag to run autocalculate the error vector

-z, --zt <zt>

redshift of the object

-b, --bcont

flag to run deactivate autosubstract continum

-s, --sprogressd

deactivate the progress bar

-i, --it <it>

i index for test, default nx/2

-j, --jt <jt>

j index for test, default ny/2

-l, --lorentz

activate the lorenztiant profile

-d, --powlaw

activate the power law continum

-r, --feii

activate the FeII template fitting

-f, --fluxf <fluxf>

flux factor

-q, --line_config <line_config>

line model configuration file

-w, --line_config_path <line_config_path>

path to the line model configuration file

runoned

obtain the spectra model

Usage

run_mapline runoned [OPTIONS]

Options

-g, --config_file <config_file>

name of the config file

-n, --name <name>

name of the spectra file

-o, --name_out <name_out>

name of the output files

-p, --path <path>

path to the data cubes

-y, --path_out <path_out>

path of the output files

-c, --ncpus <ncpus>

number of CPUs

-k, --kskew

flag to run skew line profile mode

-u, --outflow

flag to run outflow line profile mode

-e, --error

flag to run autocalculate the error vector

-z, --zt <zt>

redshift of the object

-b, --bcont

flag to run deactivate autosubstract continum

-f, --fluxf <fluxf>

flux factor

-l, --lorentz

activate the lorenztiant profile

-i, --input_format <input_format>

input of the spectra file

-q, --line_config <line_config>

line model configuration file

-w, --line_config_path <line_config_path>

path to the line model configuration file

-m, --smoth

flag to activate a smothing of the spectra

-h, --ker <ker>

value in pixels of the smothin kernel