updates for 2024 (#31)

ReimarBauer · matrss · web-flow · commit 7588c0576420 · 2024-01-05T12:39:44.000+01:00
* updates for 2024

* url fixed

* Update docs/01_about.md

Co-authored-by: Matthias Riße &lt;9308656+matrss@users.noreply.github.com&gt;

* Update docs/01_about.md

Co-authored-by: Matthias Riße &lt;9308656+matrss@users.noreply.github.com&gt;

* Update docs/02_installation.md

Co-authored-by: Matthias Riße &lt;9308656+matrss@users.noreply.github.com&gt;

* Update docs/02_installation.md

Co-authored-by: Matthias Riße &lt;9308656+matrss@users.noreply.github.com&gt;

* Update docs/02_installation.md

Co-authored-by: Matthias Riße &lt;9308656+matrss@users.noreply.github.com&gt;

* Update docs/develop/Getting-Started.md

Co-authored-by: Matthias Riße &lt;9308656+matrss@users.noreply.github.com&gt;

* Update docs/develop/Getting-Started.md

Co-authored-by: Matthias Riße &lt;9308656+matrss@users.noreply.github.com&gt;

* Update docs/develop/Setup-Instructions.md

Co-authored-by: Matthias Riße &lt;9308656+matrss@users.noreply.github.com&gt;

* Update docs/develop/Setup-Instructions.md

Co-authored-by: Matthias Riße &lt;9308656+matrss@users.noreply.github.com&gt;

* Update docs/develop/Setup-Instructions.md

Co-authored-by: Matthias Riße &lt;9308656+matrss@users.noreply.github.com&gt;

---------

Co-authored-by: Matthias Riße &lt;9308656+matrss@users.noreply.github.com&gt;
diff --git a/docs/01_about.md b/docs/01_about.md
@@ -44,11 +44,11 @@ MSS is a client/server application written in the language **Python**.
 This is used to create flight plans and discuss these with pilots of
 research aircraft. The flight path is designed by local and remote
 scientists based on meteorologic forecast data on the QT5 MSS gui
-application. A [publication by Rautenhaus et
-al.](http://www.geosci-model-dev.net/5/55/2012/gmd-5-55-2012.pdf)
-summarizes the principle of this software. At the EuroPython conference,
-a [overview
-talk](https://pyvideo.org/europython-2017/mss-software-for-planning-research-aircraft-missions.html)
+application.
+Two publications are available, one by [Bauer et al.](https://gmd.copernicus.org/articles/15/8983/2022/gmd-15-8983-2022.pdf) 
+and the other by [Rautenhaus et al.](http://www.geosci-model-dev.net/5/55/2012/gmd-5-55-2012.pdf),
+which summarize the principle of this software. On the EuroPython conference a
+[overview talk](https://pyvideo.org/europython-2017/mss-software-for-planning-research-aircraft-missions.html)
 about MSS was held.
 
 The MSS software includes a template for a Webmap server providing own
diff --git a/docs/02_installation.md b/docs/02_installation.md
@@ -11,56 +11,37 @@ permalink: /install/
 ## Install distributed version by conda
 
 
-[Anaconda](https://www.continuum.io/why-anaconda) provides an
-enterprise-ready data analytics platform that empowers companies to
-adopt a modern open data science analytics architecture.
-
-MSS is available as anaconda package on the channel.
+We are based on [miniforge](https://github.com/conda-forge/miniforge#download),
+which provides the minimal installers for Conda and Mamba specific to conda-forge. The packages of the base are from the conda-forge channel.
+conda-forge is the default and only channel configured.
+MSS is available as a conda package on the channel.
 
 [conda-forge/mss](https://anaconda.org/conda-forge/mss)
 
-The conda-forge packages are based on defaults and other conda-forge
-packages. This channel conda-forge has builds for osx-64, linux-64,
-win-64
+The conda-forge channel has builds for osx-64, linux-64 and win-64.
 
 The conda-forge [github organization](https://conda-forge.github.io/)
 uses various automated continuous integration build processes.
 
-### conda-forge channel
-
-Please add the channel conda-forge to your defaults:
-
-    $ conda config --add channels conda-forge
-
-The last channel added gets on top of the list. This gives the order:
-
-```
-channels:
-- conda-forge
-- defaults
-```
-
-First search in conda-forge.
 
 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). :
+versions for dependencies:
 
-    $ conda create -n mssenv mamba
-    $ conda activate mssenv
-    (mssenv) $ mamba install mss
+    $ mamba create -n mssenv mss
+    $ mamba activate mssenv
+    (mssenv) $ mss -h
 
 Afterwards reactivate the environment, this sets all env variables needed.
 
-    (mssenv) $ conda deactivate
-    $ conda activate mssenv
+    (mssenv) $ mamba deactivate
+    $ mamba activate mssenv
 
 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. 
 
-    $ conda activate mssenv
+    $ mamba activate mssenv
     (mssenv) $ mamba update mss
     (mssenv) $ mamba update --all
 
diff --git a/docs/04_gsoc.md b/docs/04_gsoc.md
@@ -37,12 +37,10 @@ We have labled small sized issues as "good first issue" on <https://github.com/O
  * [msui: Overlay Measured Data](/develop/GSOC/overlay_measured_data)
 
 ## Difficulty level: Medium
- * [msui: Modernize fs_filepicker](/develop/GSOC/modernize_fs_filepicker)
  * [cli: Improve Tutorials](/develop/GSOC/improve_tutorials)
  * [wms: Plot Gallery integrated](/develop/GSOC/integrated_plot_gallery)
  * [wms: Implement and support color bars being served](/develop/GSOC/color_bars_served)
  * [msui/msc: View Layout and Restoring](/develop/GSOC/view_restoring)
- * [msc: Implement a SAML 2.0 service provider (SP) into mscolab](/develop/GSOC/saml_for_mscolab)
  
 
 
@@ -64,6 +62,12 @@ proposal submission deadline so you can make changes in time.
 
 You can take a look at the following projects from previous years to get help for your proposal.
 
+### GSoC'23 Projects
+
+- [Shubh Gaur: Mission Support System(MSS) : UI-improvements : GSOC 2023](https://github.com/Open-MSS/MSS/wiki/UI%E2%80%90improvements-GSOC-2023)
+- [Nilupul Manodya: Mission Support System : Implement a SAML 2.0 service provider (SP) into mscolab : GSOC 2023](https://github.com/Open-MSS/MSS/wiki/Implement-a-SAML-2.0-service-provider-(SP)-into-mscolab-:-GSOC-2023)
+
+
 ###  GSoC'22 Projects
 
 - [Sreelakshmi Jayarajan: Automated Command Line Plotting Tool : GSoC 2022](https://github.com/Open-MSS/MSS/wiki/Automated-Command-Line-Plotting-Tool-:-GSoC-2022)
diff --git a/docs/develop/GSOC/SAML_for_mscolab.md b/docs/develop/GSOC/SAML_for_mscolab.md
diff --git a/docs/develop/GSOC/improve_tutorials.md b/docs/develop/GSOC/improve_tutorials.md
@@ -8,21 +8,22 @@ exclude: true
 # msui: Improve Tutorials
 
 - **Project description**:
-    Improve the existing tutorial scripts. Reduce duplicated code lines. 
-    Create a construction kit for common features. e.g. create account, load first wms server.
-    Use the methods of the construction kit on a started MSS to automate this. 
+    Improve the existing tutorial scripts. 
     Merge Text / Audio with movies.
-    Make the tutorials creatable in background without screen. Recreate a bunch of tutorials on each pull request.
-    Add new tutorials.
+    Make the tutorials creatable in background without a screen,
+    e.g. xvfb-run on a docker setup  Create a bunch short new tutorials.
+    Add new tutorial scripts and potentially integrate the tutorials into the test suite,
+    as a sort of integration test.
     
-- **Duration**: 175h - 350h
+- **Duration**: 90h - 350h
 
-- **Skills**: Python, Qt, Git 
+- **Skills**: Python, Qt, Git, AI-Assistant
 
 - **Difficulty level**: Medium
 
 - **Related Readings/Links**:
   - https://mss.readthedocs.io/en/stable/tutorials.html
 
 - **Potential mentors**:
-    rb.proj@gmail.com
+    rb.proj@gmail.com, m.risse@fz-juelich.de
+    
diff --git a/docs/develop/GSOC/integrated_plot_gallery.md b/docs/develop/GSOC/integrated_plot_gallery.md
@@ -15,10 +15,12 @@ exclude: true
   Besides existing parameters new have to become enabled, e.g. mapsection, projection. 
   An extension to a larger project is to add an interactive user interface.
 
-* **Duration**: 175h - 350h
-* **Skills**: Python, QT, UI programming, Git
+* **Duration**: 90h - 350h
+* **Skills**: Python, QT, UI programming, Git, AI-Assistant
 * **Difficulty level**: Medium
 * **Related Readings/Links**:
   * https://mss.readthedocs.io/en/stable/gallery/index.html
   * https://mss.readthedocs.io/en/stable/mswms.html?highlight=gallery#standalone-server-setup
+  * https://mss.readthedocs.io/en/stable/tutorial.html
+  
 * **Potential mentors**: rb.proj@gmail.com, j.ungermann@fz-juelich.de
diff --git a/docs/develop/GSOC/modernize_fs_filepicker.md b/docs/develop/GSOC/modernize_fs_filepicker.md
diff --git a/docs/develop/GSOC/overlay_measured_data.md b/docs/develop/GSOC/overlay_measured_data.md
@@ -13,10 +13,11 @@ exclude: true
   An option shall be implemented to overlay this data to the Linear Views.
   In addition scatter plots with two data types shall be enabled.  
   This plugin shall be integrated with the multilayer feature.
-* **Duration**: 175h - 350h
-* **Skills**: Python, Qt, Git
+* **Duration**: 90h - 350h
+* **Skills**: Python, Qt, Git, AI-Assistant
 * **Difficulty level**: Medium - Hard
 * **Related Readings/Links**:
   * https://mss.readthedocs.io/en/stable/gallery/index.html
   * https://mss.readthedocs.io/en/stable/gallery/plot_examples/plot_example_LS.html
+  * https://mss.readthedocs.io/en/stable/tutorial.html
 * **Potential mentors**: rb.proj@gmail.com, j.ungermann@fz-juelich.de
diff --git a/docs/develop/GSOC/support_color_bars_being_served.md b/docs/develop/GSOC/support_color_bars_being_served.md
@@ -19,10 +19,11 @@ This task entails
 2. properly address "nice" displaying of the colorbar in the frontend for typical use-cases (i.e. less than 3 bars)
 3. Revamping the existing plotting layers to use this feature.
 
-- **Duration**: 175h
-- **Skills**: Python, QT, UI programming, Git
+- **Duration**: 90-350h
+- **Skills**: Python, QT, UI programming, Git, AI-Assistant
 - **Difficulty level**: Medium
 - **Related Readings/Links**:
   - https://github.com/Open-MSS/MSS/issues/1375
   - https://www.ogc.org/standards/wms
-- **Potential mentors**: rb.proj@gmail.com, j.ungermann@fz-juelich.de
+  - https://mss.readthedocs.io/en/stable/tutorial.html
+- **Potential mentors**: rb.proj@gmail.com, j.ungermann@fz-juelich.de
diff --git a/docs/develop/GSOC/support_of_simple_trajectory_calculations.md b/docs/develop/GSOC/support_of_simple_trajectory_calculations.md
@@ -18,11 +18,12 @@ with a given set of parameters like climbing rate and ceiling altitude.
 The MSS server usually has already the data necessary for performing the calculations, but a simple trajectory 
 module would need to be implemented/connected. Also, a WMS extension will need to be specified and implemented.
 
-- **Duration**: 350h
-- **Skills**: Python, QT, UI programming, Git
+- **Duration**: 90-350h
+- **Skills**: Python, QT, UI programming, Git, AI-Assistant
 - **Difficulty level**: Hard
 - **Related Readings/Links**:
     - https://www.msc-ep.uni-bremen.de/services/lectures/practicals/pr_trajectories_2019.pdf
     - https://predict.habhub.org/
+    - https://mss.readthedocs.io/en/stable/tutorial.html
 - **Potential mentors**:
     j.ungermann@fz-juelich.de, c.rolf@fz-juelich.de
diff --git a/docs/develop/GSOC/view_restoring.md b/docs/develop/GSOC/view_restoring.md
@@ -14,17 +14,19 @@ exclude: true
   Such a View configuration consists of many windows with a complex set of configuration options that 
   are tedious to re-create after shutting down the application.
   The mscolab UI should allow for storing and restoring the view configuration of  
-  multiple windows for the user for an operation.
+  multiple windows for the user for an operation. 
+  This includes also to store all qsetting parameters on the server.
 
   A configuration should been selectable for another flightpath and operation. 
   There should also be a layout option given to any participant of the same flightpath,
   e.g. two topview connected to different wms servers. 
-  A creator of an operation should be able to set the layout of all participants.
+  A creator of an operation should be able to set the default layout of all participants.
 
-* **Duration**: 175h
-* **Skills**: Python, QT, UI programming, Git
+* **Duration**: 175-350h
+* **Skills**: Python, QT, UI programming, Git, AI-Assistant
 * **Difficulty level**: Medium
 * **Related Readings/Links**:
   * Ticket
   * QT Cache
-* **Potential mentors**: rb.proj@gmail.com, j.ungermann@fz-juelich.de
+  * https://mss.readthedocs.io/en/stable/tutorial.html
+* **Potential mentors**: rb.proj@gmail.com, j.ungermann@fz-juelich.de, m.risse@fz-juelich.de
diff --git a/docs/develop/Getting-Started.md b/docs/develop/Getting-Started.md
@@ -17,7 +17,8 @@ exclude: true
 -   Are there any unusual libraries/applications that need to be
     installed first?
 
-    We are based on [anaconda3](https://www.anaconda.com/distribution/) and [conda-forge](https://conda-forge.org/). All development is done with python 3.
+    We are based on [miniforge](https://github.com/conda-forge/miniforge#download) and [conda-forge](https://conda-forge.org/). 
+    All development is done with python 3.
 
     On linux install `xvfb` and the conda package `pyvirtualdisplay`. This is used to run tests on a virtual display.  
 
@@ -54,7 +55,8 @@ exclude: true
     
 -   What's the process for submitting your first bug fix?
 
-    We like to have a fork of the project, creating a branch based on the develop/stable branch, claiming an issue, working on that issue, talking about that, sending a pull request
+    We like to have a fork of the project, creating a branch based on the develop/stable branch, 
+    claiming an issue, working on that issue, talking about that, sending a pull request.
 
 
 -   Where should students look to find easy issues to try out?
diff --git a/docs/develop/Setup-Instructions.md b/docs/develop/Setup-Instructions.md
@@ -7,60 +7,48 @@ exclude: true
 
 ## Environment Setup
 
-### Install distributed version by conda
+### Install distributed version by mamba
 
-Install Anaconda on your system.
+Install miniforge on your system.
 
-[Anaconda](https://www.continuum.io/why-anaconda) provides an
-enterprise-ready data analytics platform that empowers companies to
-adopt a modern open data science analytics architecture.
+[Miniforge](https://github.com/conda-forge/miniforge#download) provides the minimal installers 
+for Conda and Mamba specific to conda-forge. The packages of the base are from the conda-forge channel.
+conda-forge is the default and only channel configured.
 
-MSS is available as anaconda package on the channel.
+MSS is available as a package on the channel conda-forge.
 
 [conda-forge/mss](https://anaconda.org/conda-forge/mss)
 
-The conda-forge packages are based on defaults and other conda-forge
-packages. This channel conda-forge has builds for osx-64, linux-64,
-win-64
-
-### conda-forge channel
-
-Please add the channel conda-forge to your defaults:
-
-    $ conda config --add channels conda-forge
-
-The last channel added gets on top of the list. This gives the order:
-
-```
-channels:
-- conda-forge
-- defaults
-```
-
-First search in  conda-forge.
+The conda-forge channel has builds for osx-64, linux-64 and win-64.
 
 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). :
+versions for dependencies. :
 
-    $ conda create -n mssdev python=3 mamba
-    $ conda activate mssdev
-    (mssdev) $ mamba install mss --only-deps
+    $ mamba create -n mssdev mss --only-deps
+    $ mamba activate mssdev
+    (mssdev) $ 
 
 Afterwards reactivate the environment, this sets all env variables needed.
 
-    (mssdev) $ conda deactivate
-    $ conda activate mssdev
+    (mssdev) $ mamba deactivate
+    $ mamba activate mssdev
 
 ### Installing development specific packages
 
+Between the released and the develop version we have differences in used packages:
+
+    git diff stable develop -- localbuild/meta.yaml
+    
+Update accordingly of the output.
+
 For testing and building docs you need to install the these packages by running the following command:
 
     (mssdev) $ mamba install --file MSS/requirements.d/development.txt
 
 ## Running The Application
 
-MSS has 3 main components. These are MSUI (GUI), MSWMS (web map server) and MSCOLAB (collaboration server). You can run all 3 components individually on your system. (Before running any of the commands make sure you have activated your conda environment.)
+MSS has 3 main components. These are MSUI (GUI), MSWMS (web map server) and MSCOLAB (collaboration server). You can run all 3 components individually on your system. 
+(Before running any of the commands make sure you have activated your environment.)
 
 You need to first add the main mss folder which will be created in your home directory to your python path. Go into the cloned repo and update your python path:
 
