375 - updated pyincore, pyincore-viz and pyincore-data installation instructions

CHANGELOG.md

@@ -8,6 +8,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Changed
 - Update flood input to nonstructural damage output for combined wind-wave-surge building damage [#566](https://github.com/IN-CORE/incore-docs/issues/566)
+- pyincore, pyincore-viz and pyincore-data installation instructions to include how to use libmamba solver [#375](https://github.com/IN-CORE/incore-docs/issues/375)
+
 
 ## [4.11.0] - 2024-04-30
 

manual_jb/content/faq.md

@@ -105,6 +105,7 @@
     very explicitly if they occur e.g. package X requires package Y version <5.0. We make sure that pyIncore works with 
     fresh environment and in this case we recommend re-installing pyIncore.
     <br />
+    <br />
 
 *   *Should I use virtual environment for running the pyIncore?*
 
@@ -118,6 +119,18 @@
     Note: Use Anaconda if you do not have full administrative privileges on your computer. It has been reported that 
     Jupyter Notebook can't be subsequently installed in Miniconda environment. With Anaconda **Jupyter Notebook** is already 
     pre-installed.
+    <br />
+    <br />
+
+*   *When installing pyIncore, it takes a long time to resolve dependencies. Is there anything I can do?*
+
+    We recommend trying the libmamba solver to improve dependency resolution. When installing pyIncore, use the
+    following command:
+
+    ```
+    conda install -c in-core pyincore --solver=libmamba
+    ```
+    <br />
 
 
 ### Running pyIncore

manual_jb/content/getting_started.md

@@ -67,10 +67,24 @@ If you don't have Miniconda installed, do the following steps.
     ```
     conda install -c in-core pyincore
     ```
+
+   If you have trouble installing pyincore or it is taking a long time to resolve the dependencies, try using the libmamba solver by running the following command:
+
+    ```
+    conda install -c in-core pyincore --solver=libmamba
+    ```
+
    A user can also install **pyIncore-viz** module for which **pyIncore** installs as a dependency:
     ```
     conda install -c in-core pyincore-viz
     ```
+   Similarly, if you have issues installing pyincore-viz, you can use the libmamba solver flag to resolve the
+   dependencies by running the following command:
+
+    ```
+    conda install -c in-core pyincore-viz --solver=libmamba
+    ```
+
    If the installed pyincore or pyincore-viz version is not the latest or lower than the desired one, specify the version number in installation command.
     ```
     conda install -c in-core pyincore=1.14.0 (or your version of choice)
@@ -230,4 +244,4 @@ If you have problems running Notebooks, check our [WIKI questions](https://opens
 * The Building analysis Jupyter Notebook is also available at [IN-CORE project](https://github.com/IN-CORE/incore-docs/blob/main/notebooks/bridge_dmg.ipynb) on GitHub.
 * Our Slack channel is now open to the community. To get started, go to
   [https://in-core.slack.com/](https://in-core.slack.com/). Or, you can grab an invitation here:
-[https://join.slack.com/t/in-core/shared_invite/zt-25zffgnae-h0v8uGjpSli1YYp0Ypr68Q](https://join.slack.com/t/in-core/shared_invite/zt-25zffgnae-h0v8uGjpSli1YYp0Ypr68Q)
+[https://join.slack.com/t/in-core/shared_invite/zt-25zffgnae-h0v8uGjpSli1YYp0Ypr68Q](https://join.slack.com/t/in-core/shared_invite/zt-25zffgnae-h0v8uGjpSli1YYp0Ypr68Q)

manual_jb/content/pyincore/install_pyincore.md

@@ -11,10 +11,25 @@ These steps guides you on how to install both pyIncore and Jupyter Notebooks on
     ```
     conda install -c in-core pyincore
     ```
+   If you have trouble installing pyincore or it is taking a long time to resolve the dependencies, try using the
+   libmamba solver by running the following command:
+
+    ```
+    conda install -c in-core pyincore --solver=libmamba
+    ```
+
    A user can also install **pyIncore-viz** module for which **pyIncore** installs as a dependency:
     ```
     conda install -c in-core pyincore-viz
     ```
+
+   Similarly, if you have issues installing pyincore-viz, you can use the libmamba solver flag to resolve the
+   dependencies by running the following command:
+
+    ```
+    conda install -c in-core pyincore-viz --solver=libmamba
+    ```
+
    If the installed pyincore version is not the latest or lower than the desired one, specify the version number in installation command.
     ```
     conda install -c in-core pyincore=1.14.0 (or your version of choice)

manual_jb/content/pyincore/quick_reference.md

@@ -27,6 +27,14 @@
     ```
     conda install -c in-core pyincore-viz
     ```
+
+   If you have trouble installing pyincore and pyincore-viz or it is taking a long time to resolve the dependencies,
+   try using the libmamba solver by running the following command:
+
+    ```
+    conda install -c in-core pyincore-viz --solver=libmamba
+    ```
+
    If the installed pyincore or pyincore-viz version is not the latest or lower than the desired one, specify the version number in installation command.
     ```
     conda install -c in-core pyincore-viz=1.8.3 (or your version of choice)

manual_jb/content/pyincore_data.md

@@ -18,6 +18,13 @@ or [Miniconda](https://docs.conda.io/en/latest/miniconda.html).
     ```
     conda install -c in-core pyincore-data
     ```
+
+   If you have trouble installing pyincore-data or it is taking a long time to resolve the dependencies, try using the
+   libmamba solver by running the following command:
+
+    ```
+    conda install -c in-core pyincore-data --solver=libmamba
+    ```
    If the installed pyincore-data version is not the latest or lower than the desired one, specify the version number in installation command.
     ```
     conda install -c in-core pyincore-data=0.5.0 (or your version of choice)

manual_jb/content/pyincore_viz.md

@@ -32,6 +32,13 @@ or [Miniconda](https://docs.conda.io/en/latest/miniconda.html).
     ```
     conda install -c in-core pyincore-viz
     ```
+   If you have trouble installing pyincore-viz or it is taking a long time to resolve the dependencies, try using the
+   libmamba solver by running the following command:
+
+    ```
+    conda install -c in-core pyincore-viz --solver=libmamba
+    ```
+
    If the installed pyincore-viz version is not the latest or lower than the desired one, specify the version number in installation command.
     ```
     conda install -c in-core pyincore-viz=1.5.0 (or your version of choice)