Escalate updates

eic · Jan 6, 2021 · 89c2d0f · 89c2d0f
1 parent 8b69b2f
commit 89c2d0f
Show file tree

Hide file tree

Showing 18 changed files with 493 additions and 205 deletions.
diff --git a/README.md b/README.md
@@ -165,7 +165,11 @@ Go to {% include navigation/findlink.md name='jupyterhub.jlab.org' %} (follow au
 In the **Spawner options** -> **Select a notebook image**, 
 set **eic-notebook (dev)** there
 
-<img src="https://gitlab.com/eic/escalate/workspace/-/raw/master/img/jlab_jupyterhub_spawner.jpg" style="width:400pt">
+.. figure:: _images/jlab_jupyterhub_spawner.jpg
+   :alt: jlab\_jupyterhub\_spawner
+   :width: 400
+
+   jlab\_jupyterhub\_spawner
 
 
 You should end up in your jefferson lab home directory. 
@@ -254,8 +258,3 @@ g4e = Geant4Eic()\
 ```
 
 Look at the docker or [tutorials repo](https://gitlab.com/eic/escalate/workspace) for more examples
-
-
-
-
-
diff --git a/docs/015_local_install.rst b/docs/015_local_install.rst
diff --git a/docs/020_spack.md b/docs/020_spack.md
diff --git a/docs/010_containers.rst → docs/100_containers.rst b/docs/010_containers.rst → docs/100_containers.rst
@@ -1,5 +1,7 @@
-Docker images
-=================
+Containers
+==========
+
+We use Docker as the default containerization technology. Singularity is also can be easily used utilizing docker images. 
 
 The primary goal of the images is to provide an easy means for scientists to start running EIC software. There 4 main images:
 
@@ -58,7 +60,6 @@ The Docker_ virtualization software is available for Linux, macOS, and Windows.
 .. _Docker Engine: https://hub.docker.com/search/?type=edition&offering=community
 
 
-
 Obtaining the EIC Software image
 --------------------------------
 
@@ -71,6 +72,7 @@ The EIC Software images are deployed using the electronioncollider swarm on Dock
 This requires Docker to be running on the local system. 
 Please see the `Troubleshoot`_ section if you receive the error message of ```no space left on device```. 
 
+
 Running the EIC Software image
 ------------------------------
 
@@ -90,6 +92,7 @@ and can be accessed via the host system’s native web browser.
 
 This requires Docker to be running on the local system. The ```--rm``` flag is used to automatically clean up the container and remove the file system (and all modified and created files with it) when the container exits.  The flag is included for the sake of tutorials but not needed when working with the JupyterLab environment where retaining all data in the container (including all changes and modifications) might be preferred. By default (without ```--rm``` flag), a container’s file system persists even after the container exits. 
 
+
 Troubleshoot
 ------------
 
@@ -122,8 +125,9 @@ escalate and escalate-gui images. E.g. showing standard root browser or Geant4 e
 What is the best option:
 
 
+
 1. SSH -X
----------
+.........
 
 eicuser password is eicuser
 
@@ -141,7 +145,7 @@ connect with SSH:
 
 
 2. X11
-------
+......
 
 The most convenient is using X11 directly. It require x11 client apps on Macs and Windows and may have some issues with user id's and permissions on Posix (max & linux). 
 It might sound complex, but actiually it is simple and works most of the times. Still we don't use this way for the tutorials, but it is available in the documentation. 
@@ -152,7 +156,7 @@ It might sound complex, but actiually it is simple and works most of the times.
 You can use X11 natively (as natively as possible) with this docker image in your system:
 
 Linux
-.....
+^^^^^
 
 To use graphics, make sure you are in an X11 session and run the following command: 
 
@@ -164,9 +168,9 @@ To use graphics, make sure you are in an X11 session and run the following comma
 There might be issues with user id on systems like JLab farms. 
 
 Windows
-.......
+^^^^^^^
 
-To enable graphics, you must have [VcXsrv](https://sourceforge.net/projects/vcxsrv/files/latest/download) installed. 
+To enable graphics, you must have `VcXsrv <https://sourceforge.net/projects/vcxsrv/files/latest/download>`_ installed. 
 Make sure VcXsrv is whitelisted in the Windows firewall when prompted. 
 
 Start VcXsrv with 'allow from any origin' flag
@@ -177,7 +181,7 @@ Start VcXsrv with 'allow from any origin' flag
 
 
 OSX
-...
+^^^
 
 To use graphics on OSX, make sure XQuarz is installed. 
 After installing, open XQuartz, and go to XQuartz, Preferences, select the Security tab, and tick the box 
@@ -206,7 +210,6 @@ Finally, you can start up docker with the following command:
 
 
 
-
 **Credits**:
 
 The EIC Container project is coordinated by 

diff --git a/docs/200_local_install.rst b/docs/200_local_install.rst
@@ -0,0 +1,33 @@
+Local isntallation
+==================
+
+There are several ways how one can install packages locally:
+
+1. Spack package manager
+2. EJPM package manager
+3. Combined Conda+EJPM isntallation
+4. Manual build
+
+What packet manager to use? 
+
+EJPM was designed with user laptops/workstations and devlopment in mind. The intention of EJPM is to be a user friendly CLI alternative to "build scritps" that compiles chains of packages with right flags.
+Spack is a full featured multi-platform package manager designed for clusters and super computers. It is possible to install software on laptops with Spack but at this point it is more prone to compilation errors. 
+
+**Thus the recommendation is**: to use EJPM for personal laptops with Linux OS for personal use and development. Use Spack on farms or if you are familiar with Spack, use Spack for other projects, etc.
+
+There is also a hybrid variant of using Conda+EJPM where Conda is used to download binaries of compilers, big packages like CERN ROOT and Geant4 and then EJPM is used to build EIC applications on top of it. 
+This type of installation also guarantee a consistency with compillers, binary libraries, etc.
+
+Here is the short comparison table between Spack and EJPM:
+
+.. Table with EJPM vs Spack comparison
+
+.. raw:: html
+   :file: 202_ejpm_vs_spack_table.html
+
+
+:ref:`spack-ejpm-comparison`.
+
+.. include:: 230_ejpm.rst
+
+.. include:: 240_spack.rst
diff --git a/docs/016_ejpm_vs_spack_table.html → docs/202_ejpm_vs_spack_table.html b/docs/016_ejpm_vs_spack_table.html → docs/202_ejpm_vs_spack_table.html
diff --git a/docs/017_ejpm_vs_spack_detailed.rst → docs/204_ejpm_vs_spack_detailed.rst b/docs/017_ejpm_vs_spack_detailed.rst → docs/204_ejpm_vs_spack_detailed.rst
@@ -1,3 +1,4 @@
+:orphan:
 
 .. _spack-ejpm-comparison:
 
@@ -7,6 +8,7 @@ Detailed comparison between EJPM and Spack
 
 .. Table with EJPM vs Spack comparison
 
+
 .. raw:: html
    :file: 016_ejpm_vs_spack_table.html