diff --git a/hub/LINUX_INSTALL.md b/hub/LINUX_INSTALL.md new file mode 100644 index 00000000..2b93b9da --- /dev/null +++ b/hub/LINUX_INSTALL.md @@ -0,0 +1,59 @@ +# LINUX_INSTALL +## Prepare your environment +### Install Miniconda +1. Get the link for the latest version of Miniconda from https://docs.conda.io/en/latest/miniconda.html +2. Download the installer using wget + ```` + wget https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh + ```` +3. Make the installer executable + ```` + chmod +x ./Miniconda3-latest-Linux-x86_64.sh + ```` +4. Run the installer + ```` + ./Miniconda3-latest-Linux-x86_64.sh + ```` +5. Holder enter until you are prompted to accept the license terms. Enter yes. +6. Initialize the conda environment + ```` + conda init bash + ```` +7. Source .bashrc + ```` + source ~/.bashrc + ```` +8. Create a conda environment for the hub + ```` + conda create --name hub python=3.9.16 + ```` + +### Setup SRA +1. Get the sra binary and libshortwave.so library from Guille or Koa +2. Place the binary and the library into your directory of choice +3. Make a symlink for the binary and place it into /usr/local/bin/sra + ```` + sudo ln -s ~/sra /usr/local/bin/sra + ```` +4. Make a symlink for the library and place it into /usr/local/lib/libshortwave.so + ```` + sudo ln -s ~/libshortwave.so /usr/local/lib/libshortwave.so + ```` +### Setup INSEL +1. Get the TBD from Guille or Koa +2. Place the TBD into your directory of choice +3. Make a symlink for the binary and place it into /usr/local/bin/tbd + ```` + sudo ln -s ~/sra /usr/local/bin/tbd + ```` +4. Make a symlink for the library and place it into /usr/local/lib/tbd + ```` + sudo ln -s ~/libshortwave.so /usr/local/lib/tbd + ```` + +### Get a Python editor +You are welcome to use the Python editor of your preference. The CERC team generally uses PyCharm to develop the hub. +The latest version of PyCharm can be downloaded from [JetBrains website](https://www.jetbrains.com/pycharm/promo/?source=google&medium=cpc&campaign=14127625109&term=pycharm&content=536947779504&gad=1&gclid=CjwKCAjw0ZiiBhBKEiwA4PT9z2AxPfy39x_RcBqlYxJ6sm_s55T9qvA_sZ8ZfkhIVX6FOD-ySbmzARoCcpQQAvD_BwE). + For setup and installation instructions, please view the "Get a Python Editor" +from the [WINDOWS_INSTALL](https://nextgenerations-cities.encs.concordia.ca/gitea/CERC/hub/src/branch/main/hub/WINDOWS_INSTALL.md) +documentation. \ No newline at end of file diff --git a/hub/WINDOWS_INSTALL.md b/hub/WINDOWS_INSTALL.md index c8db417b..c31860a0 100644 --- a/hub/WINDOWS_INSTALL.md +++ b/hub/WINDOWS_INSTALL.md @@ -62,6 +62,14 @@ To solve it, type 'Set-ExecutionPolicy Unrestricted' as shown in the image. ![create_sra](docs/img_windows_install/img_36.png) +### Install and setup INSEL + +1. Get the INSEL installer from Guille or Koa +2. Run the installer to completion using the default installation path +3. Add the INSEL installation folder to the Path + +![create_sra](docs/img_windows_install/img_41.png) + ### Get a Python editor 1. You will need a python editor in order to import the existing Hub source code and to write your own python code. diff --git a/hub/docs/img_macos_install/img_macos_install/img_0.png b/hub/docs/img_macos_install/img_macos_install/img_0.png deleted file mode 100644 index 829f9124..00000000 Binary files a/hub/docs/img_macos_install/img_macos_install/img_0.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_macos_install/img_1.png b/hub/docs/img_macos_install/img_macos_install/img_1.png deleted file mode 100644 index bd5caec3..00000000 Binary files a/hub/docs/img_macos_install/img_macos_install/img_1.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_macos_install/img_10.png b/hub/docs/img_macos_install/img_macos_install/img_10.png deleted file mode 100644 index 8d6e8f26..00000000 Binary files a/hub/docs/img_macos_install/img_macos_install/img_10.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_macos_install/img_11.png b/hub/docs/img_macos_install/img_macos_install/img_11.png deleted file mode 100644 index f5071a18..00000000 Binary files a/hub/docs/img_macos_install/img_macos_install/img_11.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_macos_install/img_12.png b/hub/docs/img_macos_install/img_macos_install/img_12.png deleted file mode 100644 index a99c097d..00000000 Binary files a/hub/docs/img_macos_install/img_macos_install/img_12.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_macos_install/img_13.png b/hub/docs/img_macos_install/img_macos_install/img_13.png deleted file mode 100644 index 8f74febf..00000000 Binary files a/hub/docs/img_macos_install/img_macos_install/img_13.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_macos_install/img_14.png b/hub/docs/img_macos_install/img_macos_install/img_14.png deleted file mode 100644 index ea939d7d..00000000 Binary files a/hub/docs/img_macos_install/img_macos_install/img_14.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_macos_install/img_15.png b/hub/docs/img_macos_install/img_macos_install/img_15.png deleted file mode 100644 index bfcfa889..00000000 Binary files a/hub/docs/img_macos_install/img_macos_install/img_15.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_macos_install/img_16.png b/hub/docs/img_macos_install/img_macos_install/img_16.png deleted file mode 100644 index f43f57c1..00000000 Binary files a/hub/docs/img_macos_install/img_macos_install/img_16.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_macos_install/img_17.png b/hub/docs/img_macos_install/img_macos_install/img_17.png deleted file mode 100644 index 05aeac44..00000000 Binary files a/hub/docs/img_macos_install/img_macos_install/img_17.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_macos_install/img_18.png b/hub/docs/img_macos_install/img_macos_install/img_18.png deleted file mode 100644 index 6bb1009c..00000000 Binary files a/hub/docs/img_macos_install/img_macos_install/img_18.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_macos_install/img_19.png b/hub/docs/img_macos_install/img_macos_install/img_19.png deleted file mode 100644 index 182a4fef..00000000 Binary files a/hub/docs/img_macos_install/img_macos_install/img_19.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_macos_install/img_2.png b/hub/docs/img_macos_install/img_macos_install/img_2.png deleted file mode 100644 index 021cf8fe..00000000 Binary files a/hub/docs/img_macos_install/img_macos_install/img_2.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_macos_install/img_3.png b/hub/docs/img_macos_install/img_macos_install/img_3.png deleted file mode 100644 index 22b775c2..00000000 Binary files a/hub/docs/img_macos_install/img_macos_install/img_3.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_macos_install/img_4.png b/hub/docs/img_macos_install/img_macos_install/img_4.png deleted file mode 100644 index 7592389b..00000000 Binary files a/hub/docs/img_macos_install/img_macos_install/img_4.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_macos_install/img_5.png b/hub/docs/img_macos_install/img_macos_install/img_5.png deleted file mode 100644 index 12e92895..00000000 Binary files a/hub/docs/img_macos_install/img_macos_install/img_5.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_macos_install/img_6.png b/hub/docs/img_macos_install/img_macos_install/img_6.png deleted file mode 100644 index 882ff66c..00000000 Binary files a/hub/docs/img_macos_install/img_macos_install/img_6.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_macos_install/img_7.png b/hub/docs/img_macos_install/img_macos_install/img_7.png deleted file mode 100644 index 31351501..00000000 Binary files a/hub/docs/img_macos_install/img_macos_install/img_7.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_macos_install/img_8.png b/hub/docs/img_macos_install/img_macos_install/img_8.png deleted file mode 100644 index 94c816f4..00000000 Binary files a/hub/docs/img_macos_install/img_macos_install/img_8.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_macos_install/img_9.png b/hub/docs/img_macos_install/img_macos_install/img_9.png deleted file mode 100644 index d801d0df..00000000 Binary files a/hub/docs/img_macos_install/img_macos_install/img_9.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_0.png b/hub/docs/img_macos_install/img_windows_install/img_0.png deleted file mode 100644 index 5a3c6035..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_0.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_1.png b/hub/docs/img_macos_install/img_windows_install/img_1.png deleted file mode 100644 index dd53449d..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_1.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_10.png b/hub/docs/img_macos_install/img_windows_install/img_10.png deleted file mode 100644 index 5e3528b4..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_10.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_11.png b/hub/docs/img_macos_install/img_windows_install/img_11.png deleted file mode 100644 index 2c87b995..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_11.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_12.png b/hub/docs/img_macos_install/img_windows_install/img_12.png deleted file mode 100644 index 99dab2f1..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_12.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_13.png b/hub/docs/img_macos_install/img_windows_install/img_13.png deleted file mode 100644 index 1542f551..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_13.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_14.png b/hub/docs/img_macos_install/img_windows_install/img_14.png deleted file mode 100644 index 822befbf..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_14.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_15.png b/hub/docs/img_macos_install/img_windows_install/img_15.png deleted file mode 100644 index 820e0790..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_15.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_16.png b/hub/docs/img_macos_install/img_windows_install/img_16.png deleted file mode 100644 index 2b53174b..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_16.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_17.png b/hub/docs/img_macos_install/img_windows_install/img_17.png deleted file mode 100644 index ebb83cb4..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_17.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_2.png b/hub/docs/img_macos_install/img_windows_install/img_2.png deleted file mode 100644 index 1ccad7a4..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_2.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_20.png b/hub/docs/img_macos_install/img_windows_install/img_20.png deleted file mode 100644 index 52bf0302..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_20.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_21.png b/hub/docs/img_macos_install/img_windows_install/img_21.png deleted file mode 100644 index cba7955c..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_21.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_22.png b/hub/docs/img_macos_install/img_windows_install/img_22.png deleted file mode 100644 index 5fd8bbca..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_22.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_23.png b/hub/docs/img_macos_install/img_windows_install/img_23.png deleted file mode 100644 index db3310d3..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_23.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_24.png b/hub/docs/img_macos_install/img_windows_install/img_24.png deleted file mode 100644 index bf1c7011..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_24.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_25.png b/hub/docs/img_macos_install/img_windows_install/img_25.png deleted file mode 100644 index ea0fdb47..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_25.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_26.png b/hub/docs/img_macos_install/img_windows_install/img_26.png deleted file mode 100644 index 747b3f2d..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_26.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_27.png b/hub/docs/img_macos_install/img_windows_install/img_27.png deleted file mode 100644 index 05912b32..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_27.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_28.png b/hub/docs/img_macos_install/img_windows_install/img_28.png deleted file mode 100644 index 58532a42..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_28.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_29.png b/hub/docs/img_macos_install/img_windows_install/img_29.png deleted file mode 100644 index 2731ddeb..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_29.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_3.png b/hub/docs/img_macos_install/img_windows_install/img_3.png deleted file mode 100644 index c9f27de3..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_3.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_30.png b/hub/docs/img_macos_install/img_windows_install/img_30.png deleted file mode 100644 index 7453f089..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_30.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_31.png b/hub/docs/img_macos_install/img_windows_install/img_31.png deleted file mode 100644 index b4805b16..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_31.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_32.png b/hub/docs/img_macos_install/img_windows_install/img_32.png deleted file mode 100644 index b7bbc2e5..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_32.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_33.png b/hub/docs/img_macos_install/img_windows_install/img_33.png deleted file mode 100644 index 4b95c30d..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_33.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_4.png b/hub/docs/img_macos_install/img_windows_install/img_4.png deleted file mode 100644 index 3818b949..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_4.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_5.png b/hub/docs/img_macos_install/img_windows_install/img_5.png deleted file mode 100644 index 7251bd7a..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_5.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_6.png b/hub/docs/img_macos_install/img_windows_install/img_6.png deleted file mode 100644 index 4797089c..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_6.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_7.png b/hub/docs/img_macos_install/img_windows_install/img_7.png deleted file mode 100644 index 3beafb22..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_7.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_8.png b/hub/docs/img_macos_install/img_windows_install/img_8.png deleted file mode 100644 index 50d9984c..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_8.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_9.png b/hub/docs/img_macos_install/img_windows_install/img_9.png deleted file mode 100644 index 3e483e84..00000000 Binary files a/hub/docs/img_macos_install/img_windows_install/img_9.png and /dev/null differ diff --git a/hub/docs/img_macos_install/img_windows_install/img_34.png b/hub/docs/img_windows_install/img_34.png similarity index 100% rename from hub/docs/img_macos_install/img_windows_install/img_34.png rename to hub/docs/img_windows_install/img_34.png diff --git a/hub/docs/img_macos_install/img_windows_install/img_35.png b/hub/docs/img_windows_install/img_35.png similarity index 100% rename from hub/docs/img_macos_install/img_windows_install/img_35.png rename to hub/docs/img_windows_install/img_35.png diff --git a/hub/docs/img_macos_install/img_windows_install/img_36.png b/hub/docs/img_windows_install/img_36.png similarity index 100% rename from hub/docs/img_macos_install/img_windows_install/img_36.png rename to hub/docs/img_windows_install/img_36.png diff --git a/hub/docs/img_macos_install/img_windows_install/img_37.png b/hub/docs/img_windows_install/img_37.png similarity index 100% rename from hub/docs/img_macos_install/img_windows_install/img_37.png rename to hub/docs/img_windows_install/img_37.png diff --git a/hub/docs/img_macos_install/img_windows_install/img_38.png b/hub/docs/img_windows_install/img_38.png similarity index 100% rename from hub/docs/img_macos_install/img_windows_install/img_38.png rename to hub/docs/img_windows_install/img_38.png diff --git a/hub/docs/img_macos_install/img_windows_install/img_39.png b/hub/docs/img_windows_install/img_39.png similarity index 100% rename from hub/docs/img_macos_install/img_windows_install/img_39.png rename to hub/docs/img_windows_install/img_39.png diff --git a/hub/docs/img_macos_install/img_windows_install/img_40.png b/hub/docs/img_windows_install/img_40.png similarity index 100% rename from hub/docs/img_macos_install/img_windows_install/img_40.png rename to hub/docs/img_windows_install/img_40.png diff --git a/hub/docs/img_windows_install/img_41.png b/hub/docs/img_windows_install/img_41.png new file mode 100644 index 00000000..d77b8c2a Binary files /dev/null and b/hub/docs/img_windows_install/img_41.png differ