Open-MSS · ReimarBauer · Feb 17, 2025 · Feb 8, 2025 · Feb 8, 2025 · Feb 13, 2025
diff --git a/README.md b/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

diff --git a/docs/components.rst b/docs/components.rst
@@ -1,3 +1,5 @@
+.. _components:
+
 Components
 ==========
 

diff --git a/docs/conf.py b/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.
 #

diff --git a/docs/development.rst b/docs/development.rst
@@ -17,6 +17,15 @@ When it is ready the developer version becomes the next stable.
 
 The stable version of MSS is tracked on `BLACK DUCK Open Hub <https://www.openhub.net/p/mss>`_
 
+
+Contributing
+------------
+
+Please read our `contributing <https://open-mss.github.io/contributing/>`_ guidelines and
+`setup instructions <https://open-mss.github.io/develop/Setup-Instructions>`_ to get
+started with MSS development.
+
+
 Using our Issue Tracker on github
 ---------------------------------
 
@@ -37,9 +46,6 @@ Then, please `create a new issue <https://github.com/Open-MSS/MSS/issues/new>`_
 Be sure to include as much detail as possible including step-by-step descriptions, specific examples, screenshots or mockups, and reasoning for why the enhancement might be worthwhile.
 
 
-
-
-
 Forking the Repo
 ----------------
 
@@ -264,7 +270,6 @@ Going to http://localhost:8083/status should now show "MSColab server". This mea
 Now you can use the MSS desktop application to connect to it using the MSColab window of the application.
 
 
-
 Code Style
 ----------