Merge pull request #2657 from Open-MSS/merge_develop_to_stable

v10 next major release

Author: ReimarBauer

AUTHORS

@@ -7,6 +7,7 @@ in alphabetic order by first name
 - Andreas Hilboll <[email protected]>
 - Anveshan Lal <[email protected]>
 - Aravind Murali <[email protected]>
+- Aryan Gupta <[email protected]>
 - Christian Rolf <[email protected]>
 - Debajyoti Dasgupta <[email protected]>
 - Hrithik Kumar Verma <[email protected]>
@@ -18,6 +19,7 @@ in alphabetic order by first name
 - Matthias Riße <[email protected]>
 - May Bär <[email protected]>
 - Nilupul Manodya <[email protected]>
+- Preetam Sundar Das <[email protected]>
 - Reimar Bauer <[email protected]>
 - Rishabh Soni <[email protected]>
 - Sakshi Chopkar <[email protected]>

CHANGES.rst

@@ -1,6 +1,65 @@
 Changelog
 =========
 
+Version 10.0.0
+~~~~~~~~~~~~~~
+Aryan Gupta has implemented during GSoC2024 several enhancements to improve communication efficiency within MSColab.
+Users can now personalize their MSColab experience by adding a profile image.
+The chat system has been enhanced with separate channels dedicated to service messages,
+which provide more granular details on collaborator actions, such as
+"waypoint {num} moved" or "created hexagon." Visual indicators show which users are currently
+active in the chat, displayed beneath their profile images. Additionally,
+the MSUI now displays the number of users actively working on a selected operation.
+These enhancements aim to provide a more intuitive and efficient communication experience for all MSColab users.
+
+Preetam Sundar Das enhanced during GSoC2024 the mssautoplot CLI Script by integrating an Autoplot Docking Widget,
+significantly extending its functionality. This new addition offers a comprehensive Graphical User Interface (GUI),
+providing users with additional features and flexibility to manage and customize their
+plot downloads effortlessly. The widget is seamlessly accessible across all
+three views (Top View, Side View, and Linear View) ensuring that users can configure
+their plots from any perspective that best suits their workflow.
+This enhancement not only simplifies the plotting process but also enhances usability
+by allowing users to interact with their plot settings in a visual, user-friendly manner.
+
+Rohit Prasad significantly improved during GSoC2024 the Multiple Flightpath Docking Widget with several key features:
+He added Select/Deselect All checkboxes for managing multiple tracks quickly,
+along with controls to adjust line thickness, style, and transparency of flight track lines.
+Additionally, he implemented an automatic distinct color selection feature.
+This ensures each new flight track is easily distinguishable by assigning unique colors from
+a predefined list, eliminating confusion caused by overlapping or similar-colored flight paths.
+Prasad also introduced customization options for flight track lines in both the
+Side View and Top View Option Widgets. Users can now adjust line thickness, style, and transparency,
+with their preferences saved for future use.
+Furthermore, he enhanced user experience by introducing a new custom color palette that provides visually
+distinct colors. This makes it easier to differentiate between multiple flight paths,
+improving both functionality and aesthetics of the application.
+
+Matthias Riße implemented a new database migration setup for MSColab,
+transitioning from versions 8 or 9 to the latest versions (v10 onwards).
+He also enhanced both the Continuous Integration (CI) setup and developer installation process.
+These improvements have resulted in a more efficient and reproducible CI environment
+while simplifying developer installations.
+By adopting pixi (prefix-dev), the project can now manage dependencies more effectively,
+ensuring that both local development environments and the CI environment are consistent.
+This alignment leads to fewer errors, faster updates, and an overall smoother workflow.
+
+Jörn Ungermann reorganized the archive of operations and enhanced the request processes for MSColab Operations.
+
+Reimar Bauer made several improvements to the handling of operations in both MSUI and MSColab.
+
+HINT:
+~~~~~
+The MSColab database migration process has been updated.
+Please follow the steps outlined in our documentation.
+Additionally, we have modified the installation process by introducing pixi (prefix-dev).
+Pixi packages can coexist with both Anaconda default and Miniforge3 conda-forge packages.
+However, it is important to note that Anaconda's default channel is incompatible with conda-forge.
+The MSColab Server model has been updated, and it now requires an MSUI of the same version to function correctly.
+However, the compatibility with the MSWMS Server remains unchanged.
+
+All changes:
+https://github.com/Open-MSS/MSS/milestone/103?closed=1
+
 
 Version 9.3.1
 ~~~~~~~~~~~~~

README.md

@@ -12,65 +12,71 @@ into the right direction in order to get the software working on your
 computer.
 
 
-Installing MSS
-==============
+## Installing MSS
 
-Automatically
--------------
+We distinguish between Developer and User installations.
 
-- For **Windows**, go [here](https://github.com/Open-MSS/mss-install/blob/main/Windows.bat?raw=1)
-    - Right click on the webpage and select "Save as..." to download the file
-    - Double click the downloaded file and follow further instructions
-        - For fully automatic installation, open cmd and execute it with `/Path/To/Windows.bat -a`
-- For **Linux/Mac**, go [here](https://github.com/Open-MSS/mss-install/blob/main/LinuxMac.sh?raw=1)
-    - Right click on the webpage and select "Save as..." to download the file
-    - Make it executable via `chmod +x LinuxMac.sh`
-    - Execute it and follow further instructions `./LinuxMac.sh`
-        - For fully automatic installation, run it with the -a parameter `./LinuxMac.sh -a`
+### Developer Installation
+Please read our [contributing](https://open-mss.github.io/contributing/) pages.
+and [development](https://mss.readthedocs.io/en/stable/development.html) guidelines
 
-Manually
---------
+### User Installation
 
-As **Beginner** start with an installation of Miniforge
-Get [miniforge](https://github.com/conda-forge/miniforge#download) for your Operation System
+Get **pixi** from https://pixi.sh/latest/ for your operation system.
 
+You can now decide if you want to install **mss** as global or a project.
 
-You must install mss into a new environment to ensure the most recent
-versions for dependencies (On the Anaconda Prompt on Windows, you have
-to leave out the 'source' here and below).
+#### Global installation
+You can install **mss** global without defining a project first.
+This method is practical when you are interested in starting the client
+and don't need server configurations.
 
-```
-  $ mamba create -n mssenv
-  $ mamba activate mssenv
-  (mssenv) $ mamba install mss python
-```
-For updating an existing MSS installation to the current version, it is
-best to install it into a new environment. If an existing environment
-shall be updated, it is important to update all packages in this
-environment.
+    pixi global install mss
 
-```
-  $ mamba activate mssenv
-  (mssenv) $ msui --update
-```
+#### Usage
 
-It is possible to list all versions of `mss` available on your platform with:
+    msui
+    mswms -h
+    mscolab -h
+    mssautoplot -h
 
-```
-    $ mamba search mss --channel conda-forge
-```
 
-For a simple test you can setup a demodata wms server and start a msolab server with default settings
+##### Updating
 
-```
-  (mssenv) $ mswms_demodata --seed
-  (mssenv) $ export PYTHONPATH=~/mss
-  (mssenv) $ mswms &
-  (mssenv) $ mscolab start &
-  (mssenv) $ msui
-```
+    pixi global update mss
 
+#### Project installation
+Initialize a new project and navigate to the project directory.
 
+    pixi init MSS
+    cd MSS
+
+Use the shell command to activate the environment and start a new shell in there.
+
+    pixi shell
+
+Add the **mss** dependencies from conda-forge.
+
+    (MSS) pixi add mss
+
+##### Usage
+Always when you want to start **mss** programs you have after its installation
+to activate the environment by pixi shell in the project dir.
+On the very first start of **msui** it takes a bit longer because it setups fonts.
+
+    cd MSS
+    pixi shell
+
+    (MSS) msui
+    (MSS) mswms -h
+    (MSS) mscolab -h
+    (MSS) mssautoplot -h
+
+##### Updating
+
+    cd MSS
+    pixi shell
+    (MSS) pixi update mss
 
 
 Current release info

conftest.py

@@ -111,9 +111,9 @@ def generate_initial_config():
     root_fs.makedir('colabTestData')
 BASE_DIR = ROOT_DIR
 DATA_DIR = fs.path.join(ROOT_DIR, 'colabTestData')
-# mscolab data directory
-MSCOLAB_DATA_DIR = fs.path.join(DATA_DIR, 'filedata')
-MSCOLAB_SSO_DIR = fs.path.join(DATA_DIR, 'datasso')
+# mscolab data directory for operation git repositories
+OPERATIONS_DATA = fs.path.join(DATA_DIR, 'filedata')
+SSO_DIR = fs.path.join(DATA_DIR, 'datasso')
 
 # In the unit days when Operations get archived because not used
 ARCHIVE_THRESHOLD = 30

docs/autoplot_dock_widget.rst

@@ -0,0 +1,97 @@
+mssautoplot - UI Setup
+======================
+
+Autoplot Docking Widget
+-----------------------
+
+**Autoplot Dockwidget Description:**
+The Docking Widget offers users a Graphical User Interface (GUI) for downloading plots based on specified configurations. It provides a user-friendly approach, integrating seamlessly with other dock widgets. This widget can be accessed across all three views—Top View, Side View, and Linear View—ensuring flexibility and ease of use for different user preferences.
+
+**Components:**
+
+The autoplot docking widget contains the following parameters which can be configured:
+
+- **Select configuration file button**: This button is used to select the JSON file for uploading the configurations to the dock widget. By default, it uses the `mssautoplot.json` file located in this path - `$HOME/.config/msui`.
+
+- **Left Treewidget**: The following parameters can be configured or updated based on requirements:
+
+  - Flight
+  - Map Sections
+  - Vertical
+  - Filename
+  - Initial Time
+  - Valid Time
+
+- **Right Treewidget**: The following parameters can be configured or updated:
+
+  - URL
+  - Layers
+  - Styles
+  - Level
+  - Start Time
+  - End Time
+  - Time Interval
+
+- **ComboBoxes**: These allow configuring the start time, end time, and time interval. Ensure that the start time is always less than the end time. The plots are downloaded from the start time to the end time at the provided time intervals.
+
+- **Download Plots Button**: This button is used to download plots based on the configurations. The configuration is saved in the `mssautoplot.json` file by default, located at `$HOME/.config/msui`.
+
+- **Update/Create JSON file**: This button will create or update the JSON file. If not present, it will update the default `mssautoplot.json` file located at `$HOME/.config/msui`.
+
+How to Use
+----------
+
+The `mssautoplot.json` file located in the `$HOME/.config/msui` directory contains the default configuration.
+
+The **left treewidget** is used to configure the automated plotting flights list:
+
+.. code-block:: json
+
+   "automated_plotting_flights":
+   [
+      ["flight1", "section1", "vertical1", "filename1", "init_time1", "time1"],
+      ["flight2", "section2", "vertical2", "filename2", "init_time2", "time2"]
+   ]
+
+- Flight, filename, and section parameters are configured in the **Top View**.
+- The vertical parameter is configured in the **Side View**.
+
+The **right treewidget** is used to configure the automated plotting flight sections, which are based on the view:
+
+- For **Top View**, it is `"automated_plotting_hsecs": [["URL", "Layer", "Styles", "Level"]]`.
+- For **Side View**, it is `"automated_plotting_vsecs": [["URL", "Layer", "Styles", "Level"]]`.
+- For **Linear View**, it is `"automated_plotting_lsecs": [["URL", "Layer", "Styles"]]`.
+
+Inserting, Updating, and Removing Configuration in the Treewidget
+-----------------------------------------------------------------
+
+There are three buttons— **Add**, **Update**, and **Remove**—under each treewidget:
+
+- **Add Button**: Inserts a row based on the current configurations.
+
+  - For the left treewidget, the current values of flight, section, vertical, filename, init_time, and time are inserted.
+  - For the right treewidget, the current values of URL, Layers, Styles, Level, Start Time, End Time, and Time Interval are inserted.
+
+- **Remove Button**: Removes the selected row.
+
+- **Update Button**: Updates the selected row with the current values (only active after selecting a row).
+
+Ensure that the **right tree widget** has at least one row before inserting into the left treewidget.
+
+Downloading the Plots
+---------------------
+
+Plots can be downloaded in the following ways:
+
+1. Upload the configuration JSON file by clicking the **Select configuration file** button, then click the **Download Plots** button to download the plots.
+2. Upload the configuration JSON file by clicking the **Select configuration file** button, then make modifications as needed.
+3. Download plots with or without flight track from start time to end time at specified time intervals. This ensures that a total of `M x N` plots are downloaded, where `M` is the number of rows in the left treewidget and `N` is the number of rows in the right treewidget.
+
+Example
+-------
+
+An `mssautoplot.json` file generated after clicking the **Update/Create Configuration file Button** in the path, e.g. “$HOME/.config/msui” by default:
+
+**/$HOME/.config/msui/mssautoplot.json**
+
+.. literalinclude:: samples/config/msui/autoplot_dockwidget.json.sample

docs/components.rst

@@ -1,3 +1,5 @@
+.. _components:
+
 Components
 ==========
 
@@ -10,5 +12,6 @@ Components
    mscolab
    gentutorials
    mssautoplot
+   autoplot_dock_widget
    conf_sso_test_msscolab
    sso_via_saml_mscolab

docs/conf.py

@@ -14,14 +14,11 @@
 import os
 import sys
 import setuptools
-import subprocess
 import requests
 import zipfile
 import shutil
 import pathlib
 
-from string import Template
-
 
 def get_tutorial_images():
     TUTORIAL_URL = "https://fz-juelich.sciebo.de/s/KcF29hPNRzkxN6q/download"
@@ -153,20 +150,6 @@ def get_tutorial_images():
 # The full version, including alpha/beta/rc tags.
 release = __version__
 
-# Replace $variables in the .rst files if on a readthedocs worker
-if "/home/docs/checkouts" in " ".join(sys.argv):
-    mss_search = subprocess.run(["conda", "search", "-c", "conda-forge", "mss"], stdout=subprocess.PIPE,
-                                stderr=subprocess.STDOUT, encoding="utf8").stdout
-    # mss_search is inside a code block, reflect indentation
-    mss_search = (" " * 3).join([line for line in mss_search.splitlines(True) if line.startswith("mss ")][-2:])
-
-    for file in os.listdir():
-        if file.endswith(".rst"):
-            with open(file, "r") as rst:
-                content = Template(rst.read())
-            with open(file, "w") as rst:
-                rst.write(content.safe_substitute(mss_version=version, mss_search=mss_search))
-
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
 #

docs/conf_sso_test_msscolab.rst

@@ -30,7 +30,13 @@ To set up a local identity provider with the mscolab server, you'll first need t
 ----------------
 Before getting started, you should correctly activate the environments, set the correct Python path as explained in the mss instructions : https://github.com/Open-MSS/MSS/tree/develop#readme
 
+Setup your
 
+**msidp_settings.py**
+
+ .. literalinclude:: samples/config/msidp/msidp_settings.py.sample
+
+.. _configuration-mscolab:
 
 2. Generate Keys, Certificates, and backend_saml files
 ------------------------------------------------------