From 4b22aa9a5950d8cdb90f73120b18e64dfffd6eb1 Mon Sep 17 00:00:00 2001
From: Hans Fangohr <hans.fangohr@mpsd.mpg.de>
Date: Tue, 20 Jun 2023 12:19:25 +0200
Subject: [PATCH] add some questions raised this morning

---
 README.rst | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 52 insertions(+)

diff --git a/README.rst b/README.rst
index 433d22a..ba99e9f 100644
--- a/README.rst
+++ b/README.rst
@@ -196,4 +196,56 @@ Octopus) using the ``foss2022a-serial`` toolchain.
 
 
 
+Frequently asked questions
+--------------------------
+
+- Can I install the ``mpsd-software-manager`` package in a python virtual environment?
+
+  Yes. ``pipx`` is probably more convenient, but you can create your own Pyton
+  virtual environment and install the ``mpsd-software-manager`` in that as a
+  regular python package::
+
+    python3 -m venv venv
+    . venv/bin/activate
+    pip install git+https://gitlab.gwdg.de/mpsd-cs/mpsd-software-manager
+
+  You just need to activate that python virtual environment before being able to
+  use the tool.
+
+- Does the command write anything outside the mpsd-software-root directory?
+
+  No. All changes to disk take place in and below the mpsd-software-root
+  directory (which is the one in which the ``mpsd-software`` command is called).
+
+- How can I uninstall the mpsd-software?
+
+  For now, the easiest is to delete the ``mpsd-software-root`` directory. You
+  can probably delete just a release subdirectory (such as ``dev-23a``) if you
+  have multiple release subdirectories installed and you only want to delete
+  one. (Untested.)
+
+- How long does the compilation take?
+
+  This depends on the hardware. A few hours are typical per toolchain. If a
+  second toolchain is compiled in the same MPSD software instance is likely to
+  be faster, in particular if the same compiler is used (and thus the compiler
+  does not need to be re-compiled for the second toolchain).
+
+- How much disk storage do I need?
+
+  A toolchain needs of the order of 5GB on disk. The second or third toolchain
+  (in the same MPSD software instance) will use less additional space, as
+  libraries and tools are re-used where possible.
+
+- Can I have more than one MPSD software instance?
+
+  Yes.
+
+  We call "MPSD software instance" all the compiled software that is stored
+  in and below a "mpsd-software-root" directory (see instructions above).
+
+  It is possible to install multiple MPSD software instances on the same
+  computer (just in different (not nested) directories. This makes it possible
+  to experiment with toolchains etc.
+
 
-- 
GitLab