configuration path root

[oliver-sanders]

Follow on from #189

This project is called cylc-uiserver, however, it configures both the hub and the UIS.

At present the config path is ~/.cylc/hub, should this be changed to ~/.cylc/uiserver to match ~/.cylc/flow?

[oliver-sanders]

Agreed, rename to uiserver.

[hjoliver]

Somewhat relatedly, the server config file can be called:

• jupyter_config.py
• jupyter_cylc_config.py
• (jupyterhub_config.py for hub-launched only)

Should we document/recommend use of jupyter_cylc_config.py for maximum clarity?

Even though cylc is in the path name for installed site and user configs, it would makes sense for command line use of temporary config files: cylc gui --config=jupyter_cylc_config.py.

[oliver-sanders]

Should we document/recommend use of jupyter_cylc_config.py for maximum clarity?

I think this file targets the Cylc extension so would not be loaded by other Jupyter components. These targeted files should be used to configure the one specific component (server, extension, hub, lab, etc) whereas we use it to configure multiple (e.g. we might set the spawner command used by the hub, set the logging config for the server and set the scan interval for the Cylc extension).

I think using the generic jupyter_config.py as documented is the clearest way.