Command-line interface#

python -m phasorpy#

PhasorPy package command-line interface.

Usage

python -m phasorpy [OPTIONS] COMMAND [ARGS]...

Options

--version#

Show the version and exit.

fetch#

Fetch sample files from remote repositories.

Usage

python -m phasorpy fetch [OPTIONS] [FILES]...

Options

--show-progress, --hide-progress#

Show progress bar.

Arguments

FILES#

Optional argument(s)

fret#

Start interactive FRET phasor plot.

Usage

python -m phasorpy fret [OPTIONS]

Options

--hide#

Do not show interactive plot.

lifetime#

Start interactive lifetime plots.

Usage

python -m phasorpy lifetime [OPTIONS] [NUMBER_LIFETIMES]

Options

-f, --frequency <frequency>#

Laser/modulation frequency in MHz.

-l, --lifetime <lifetime>#

Lifetime in ns.

-a, --fraction <fraction>#

Fractional intensity of lifetime.

--hide#

Do not show interactive plot.

Arguments

NUMBER_LIFETIMES#

Optional argument

spectral#

Start interactive spectral plots.

Usage

python -m phasorpy spectral [OPTIONS] [NUMBER_SPECTRA]

Options

-o, --origin <origin>#

Origin wavelength.

-s, --sigma <sigma>#

Spectral broadening factor.

-a, --fraction <fraction>#

Fractional intensity of component.

--hr-factor <hr_factor>#

Huang-Rhys factor.

Default:

0.4

--vib-frequency <vib_frequency>#

Vibrational frequency.

Default:

1200.0

--wavelength-min <wavelength_min>#

Minimum wavelength to display.

Default:

450.0

--wavelength-max <wavelength_max>#

Maximum wavelength to display.

Default:

650.0

--samples <samples>#

Number of wavelength samples.

Default:

128

--dho#

Use Displaced Harmonic Oscillator model.

--hide#

Do not show interactive plot.

Arguments

NUMBER_SPECTRA#

Optional argument

versions#

Show runtime versions.

Usage

python -m phasorpy versions [OPTIONS]

Options

--verbose#

Show full module paths.