diff --git a/README.rst b/README.rst index 433d22a1f057f7688d66e26905cdb0e732f93ee2..ba99e9f1580aa68edb55a62009c62cacc2cd38fc 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. +