diff --git a/docs/runconf_ui_config.md b/docs/runconf_ui_config.md index 971acf9..9a9ab80 100644 --- a/docs/runconf_ui_config.md +++ b/docs/runconf_ui_config.md @@ -9,6 +9,8 @@ The runconf_ui YAML files [stored in src/runconf_ui/configuration] are used for ## Environment setup For now shifter view looks for a configuration YAML called `/path/to/runconf_ui/src/configuration/${APPARATUS}_configuration.yml`, for example, `np02_configuration.yml`. This can also be set using the `--shifter-interface-config` flag at start up. +**NOTE** If you're not in a shifter TMUX session you need to call `source runconf_X_env_setup.sh` [currently, we have `runconf_np02_env_setup.sh` and `runconf_np04_env_setup.sh`]. This script can be called from anywhere and will initialise the TMUX environment variables required by `runconf-ui`. + The environment settings are stored in `General`. These are settable either as direct paths/variables OR if the interface finds a corresponding environment variable, that variable. In the below config you can see examples of both of these settings. One can also over-ride any of these settings using the CLI at startup. ```yml diff --git a/pyproject.toml b/pyproject.toml index 6c38ac9..8789a8a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,7 +5,7 @@ requires = ["setuptools>=61.0"] [project] name = "runconf_ui" description = "A text user interface (TUI) designed to be used to enable/disable elements of the detector" -version = "5.3.0" +version = "5.3.1" readme = "docs/README.md" requires-python = ">=3.10" dependencies = [ @@ -18,6 +18,8 @@ dependencies = [ [tool.setuptools] package-dir = {"" = "src"} include-package-data = true +script-files = ["scripts/runconf_np02_env_setup.sh", + "scripts/runconf_np04_env_setup.sh"] [tool.setuptools.packages.find] namespaces = true @@ -26,6 +28,8 @@ where = ["src"] [tool.setuptools.package-data] "*" = ["*"] + + [project.scripts] runconf-shifter-ui = "runconf_ui.apps.__main__shifter_view__:main" diff --git a/scripts/setup_np02_environment.sh b/scripts/runconf_np02_env_setup.sh similarity index 100% rename from scripts/setup_np02_environment.sh rename to scripts/runconf_np02_env_setup.sh diff --git a/scripts/setup_np04_environment.sh b/scripts/runconf_np04_env_setup.sh similarity index 100% rename from scripts/setup_np04_environment.sh rename to scripts/runconf_np04_env_setup.sh