multicolorfits.gui#

multicolorfits.gui(host='127.0.0.1', port=8321, open_browser=True, browser=None, session=None, state=None, files=None, colors=None, labels=None)[source]#

Launch the (browser-based) multicolorfits GUI.

Parameters:

  • host – Local uvicorn bind address (default 127.0.0.1:8321; port auto- increments if busy).

  • port – Local uvicorn bind address (default 127.0.0.1:8321; port auto- increments if busy).

  • open_browser (bool) – If True (default), open a browser tab when the server is ready.

  • browser (str or None) – Which browser to open when open_browser is True. Names understood by webbrowser.get() work (e.g. 'firefox', 'google-chrome', 'chromium', 'safari'), as does a full path to an executable. None uses the system default; on Unix the BROWSER environment variable is also consulted by the stdlib. Ignored when open_browser=False.

  • session (McfSession or None) – Optional pre-configured session (panels + compose state).

  • state (str or dict or None) – JSON session file path or state dict to restore on startup (see McfSession.save_state() / McfSession.load_state()).

  • files (sequence of str or None) – FITS paths to load into successive panels on startup.

  • colors (sequences or None) – Optional per-file colors and channel labels (with files).

  • labels (sequences or None) – Optional per-file colors and channel labels (with files).

Examples

>>> mcf.gui()  
>>> mcf.gui(browser='firefox')  
>>> mcf.gui(open_browser=False)  # then open the printed URL yourself

CLI equivalents: mcf-web --browser firefox, mcf-web --no-browser.

Requires the web extra: pip install multicolorfits[web]

On this page
Show Source