{ "cells": [ { "cell_type": "markdown", "metadata": {}, "source": [ "# Installing GridAPPSD-Python and Notebook Tutorials" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "## Install Anaconda or Miniconda\n", "\n", "Download the latest version of the Miniconda from the [Conda.io website](https://docs.conda.io/en/latest/miniconda.html):\n", "\n", "* [Python 3.8 for 64-bit Windows](https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86_64.exe)\n", "* [Python 3.8 for 32-bit Windows](https://repo.anaconda.com/miniconda/Miniconda3-latest-Windows-x86.exe)\n", "\n", "Use the installation wizard with the recommended settings to complete installation.\n" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "![miniconda](../images/1.3/win_setup_miniconda.png)" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "After installation is complete, launch the __Anaconda Prompt (Miniconda3)__ from the Start Menu or by typing `anaconda` in the Cortana toolbar" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "![launch-miniconda](../images/1.3/win_setup_launch_miniconda.png)" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "The miniconda terminal window will open" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "![miniconda-terminal](../images/1.3/win_setup_miniconda_terminal.png)" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "---" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "## Install GridAPPSD-Python\n", "\n", "In the Miniconda terminal window, download and install GridAPPSD-Python by running \n", "\n", "`pip install gridappsd-python` \n", "\n", "to download the GridAPPSD-Python library and required packages." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "![install-gapps-python](../images/1.3/win_setup_install_gapps_python.png)" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "GridAPPSD-Python and all dependencies should have been automatically added to your anaconda path after completion." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "---" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "## Install Jupyter Lab\n", "\n", "In the miniconda terminal window, run \n", "\n", "`pip install jupyterlab`\n", "\n", "to install the Jupyter environment for executing the python notebooks. It may take a couple minutes to collect and install all the required packages." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "![install-jupyter](../images/1.3/win_setup_install_jupyter.png)" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "---" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "## Python Training Notebooks\n", "\n", "The Jupyter / iPython training notebooks are the source materials for the GridAPPS-D ReadTheDocs website.\n", "\n", "The notebooks include all the code examples and sample app materials in a format that can connect to a local GridAPPS-D platform session and interact in real-time with simulations in real-time." ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "![notebook-platform-interaction](../images/1.3/switch_app_viz_interaction.gif)" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "### Download Python Training Notebooks\n", "\n", "In the miniconda terminal window, clone the python notebooks by running `git clone https://github.com/GRIDAPPSD/gridappsd-training` to download the python training notebooks. \n" ] }, { "attachments": { "win_setup_install_notebooks.png": { "image/png": "iVBORw0KGgoAAAANSUhEUgAAA80AAABiCAYAAABqFDFTAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsQAAA7EAZUrDhsAABarSURBVHhe7d1LbBVXmsDxz/RMT4+UkQa6O5JxIItgXuNpRUo2tlmE7GwUiZUX0JKlack81BLeeEFEVkGw8CKwAePFtJACC6/YYO9iImFbnQlRZhoQYEea2DEJUTqJxwFDMNyp79Spe6vq1qmq+zC+jv8/qeRbj1v31KlTVeerc6rc1NzcXBAAAAAAAFDGBM3379+3owAAAAAAQG3evFk22M8AAAAAACCGoBkAAAAAAAeCZgAAAAAAHAiaAQAAAABwIGgGAAAAAMCBoBkAAAAAAAeCZgAAAAAAHHL9n+a//e2m3Lx5SwqF595YkzQ16eDPKxT8vyUFM02XbWraIG1t/yZ/+MO/23kAAAAAAKwNuf9P888//yxbtrwiTRu8xb1g+bkXEC8/eyZPl5fl6dOnZv7jJ49l6fGSPHq0JA8fPZSHDx/Jxo0b5fHjx3YtAAAAAIBG4DeEZg+NRtN048YNO1ZO59U73bmD5s//+3/kk79+Ivfu3TPDp5/ekNu3bnt/P7XDjeLnG97nv3rLfvLJf8mTJ0/sWtzGDnk75NCYHWtkY3KoqVPOztjRTLp8uNBV8t3VMXO20+4Lm3bHfjHLBdszc1Y682xb3uXqIs++mpGznaX9E2yqlsfORt9RAAAAQI0KBe0l7B4akcab7Z17EgNnnabzdJl6yhU0P3nys3w195X89NNP8vCnh/L99z/I4uKiPHv2TH788Ud58O238u0DO3ifdfyrr76SO3fumBbnVF4gdfJmn/TdPNnwAWV1OuTMtF/ops+I9Pee9UK11ZIRSHr7onekR6YvdNkJHdKRuF/GZLB/0n72bDsmE4UJObbNjrvkXe6FmZbtJ+xJwds5N7sPeVsm0nVhWnpGen+h5REAAABYu9544w2ZmrheFjgHAbPO02XqKVfQrN2up2em5ZtvvpHZuTmZvjctP3z/vcx5n58/fy4PvnkgDx54gwbMXuCsn7/77jtZWFiQn58+tWtJNnN1RKRnQAZ6REau/rKjlG3HTkjf5Ig06mb6+2KfhGPatraE/TJ2RYb7+qTPjq5dXdIV3B/Ytl28TbW2ybETbdI/uBZ6PwAAAADrSzxwXsmAWeUKmp8+XZalpSUvaH4gv/7HX8vLL78sDx8teYHx38285s3Nsn37dvnNP/3GtD4Xnhf0dWCy/GxZllOD5hnx47Rtsm2fiZpDrbC2VfTsoWL32XCXWdOl206PdiFO7nLrdw1OmJ7xO+HvdZ69Zyf63GnIw//dQ4e0m7PfwpmZxrHSfJ3nd5H2x0tpLl/Wn6fTu2VYJqW/1Ztelt7SvgjbPXBC2voH/fQZXv6evClnBvbbcWV/0yTBfk7Mz/ByqoH2lbkRsN8Lo63W3dJx816oPAIAAABoFOHAeSUDZpUraNbAd3nZC4C9YWZmRqanp+X/FhZMd+3Z2Vn58n+/lFu3bpnxooL3PfuiMKeZqzIiPWLitG37vE/xVlgvwLu93+8+O9onk6HgreuC7VZbGJW+4aALsQZhrTLSM23nFcTvaewFW6390jZqv2O64oaDN9fvRL930UvfsJnuS06D28zZkzLcYbfXmJSbuy9637/gBWs50nhS5KJN43B3k/R6KSpPswot6/cJ99bTJRc0nUF38WIX7MC03J5sk+1lXae7ZH/fsFwJVh7eZ07u/VbSGPuqeOPhirfOcJ5oy/PkbS9XAAAAgHTFxpmMAWtTvqB52Q+avZDDG8s/LC8/My8Rc4l2B94m2tgc7RLrBXgDNpDp2u8FfDflXhA8jQWtjdp6amlAN9knJ+IPzc7c877ZJ/uDmGjbMTnRNym3ixGR43f0ex1nJJhlulf7H31JaSjjBXnasust19rfJqMTx0LdnztKLbt50njRftekMfTdeN6Ely1bT+W6BrzA9aT/LPbYoBeYnghvQ5KU/RZokH217diEH0zvv+LNCwfnrbK7IyHdAAAAQIzfOJM9oH7CXbLDXbVXQu7u2Ro0e3u6bMenDc+0pdkLuJP5L5Oa7G+1wYwGlZMiw1cSWiVjtBtut8io+Z1pOdNhp79IudPgBXn2RWB+i/KLNiP3btqP1Qp6AYzpS9tKgemakWdfdV2Q0Uhw7mp5BwAAALCa4s8wx59xrrd8QbNpaX4mS0uP5eFD/R/M2YMua/6XsxdwJ9JnSDvOyLQJZIJBA5pQV2CX6dsy2bFbWvWzabE0U/3gzvv+yXg/afOSp3AXYy/4Gw61ZrqYLrr9EjR+m+7V/kd3GqpVbRoTTZZe3mVbdLPXk9ayal+M1d1f9qKwqjXCvhobC92gGZMrwx2y2yzkMS3X9jsAAAAAGoLrpV8rGTjnCpofPXwkmzdvlt+//LJs3LhJNv32d/Lb3/3eOfyrt8zGTZuk5ZVX5NHSkl1L1NiVYekoC8C0i3aHDGdFzV0Dckb6pVVbqHtvS1ux5dAL7iZGpS3Ueu2/86lLLphnY/1pTa0j0jOdp9XX+559fli/1ys9pS6/zjRUq9o0JumQttu9dj36nG+wHn0+2XYXL3sZlt893vkGc93ejoTu1FVrgH3Vek9O2t/WbtsyGvp3WBpot22PlU8AAADglyOoh7uGRvTmm2+WBcyBIHDWZeqpqbm5uXD//n07muw///IXuXXrjmzYsEF+9asN5m/TBs3EpIwsyHP5B3n2z/8iz374Rnbv3CF/+tN/2HlYeWNyqOmk7J6u4v8hazfmXpGLkeeu1yN9SZnJiAb6n9IAAAAAXjRtPM4VNGMtqSFo9ujbpFtvn0h4u/b6of+eqltG13UeAAAAAPCD5lzds7F+mLdJr/Ng0fx7KgJmAAAAAB5amgEAAAAASEBLMwAAAAAAKQiaAQAAAABwIGgGAAAAAMCBoBkAAAAAAAeCZgAAAAAAHAiaAQAAAABwIGgGAAAAAMDB/J/mxcVFOwoAAAAAwNqnce7CwoIdq86uXbtoaQYAAAAAwIWgGQAAAAAAB4JmAAAAAAAcCJoBAAAAAHAgaAYAAAAAwIGgGQAAAACw7vT399tP6QiaAQAAAADrShAw5wmcCZoBAAAAAOtGPFDOCpwJmgEAAAAA60I4QD5z5oz9lB44EzQDAAAAANaVIGAOB84uBM0AAAAAgHUjHihnBc5Nzc3NhcXFRTsKAAAAAMDap3HuwsKCHavOrl27aGkGAAAAAMCFoBkAAAAAAAeCZgAAAAAAHHimGcbY2Jj91Ji6urrsJwAAAADIxjPNAAAAAACsMIJmAAAAAAAcEoPmpp1H5dKlo7Kzqckfb9opRy9dk9P7/PHV4KfhkhzduTpp2Hf6mlw6utOOrT1rPf31EJTja6Gy/aLsPHpJrl3zfluH0/vs1MbQCMd3vWWV92qOh2rLT635uxb3D+eb2qxE/lVSfpv2nV6V82RelaTvRRw/K1ne1+LxDwC/RGVBc1PTPjk11COzl8/LnULBTl19hcIdOX95VnqGTsm+Ki/k5kIbBC7eUMlFbvTiiEjn24kXaXOT4drpSLo0H09fW70gPy4t/fCtZMXnzrmD8tZbb8nhkXk7Ze3Jyp9GCZT0eDzQPiWXz9+1U6Ky5lerUbZ/tbny13X+LQZzoXnxgEjzNjJfB3vzyT//Js8LKy4XW3fi74fO51nzVdIyxe3Lmb7ASpVPNDbOHwCwcj7//POqh0BZ0Nx9akC2jhyW41cbJ2AOFK4e94KOrTJwqttOyU9b+sYHtsrI4b0meNHhfenNH9Te/UgmpEd6K//pxlBF+vXlW6sxJKlHy4feeDl30Nv3B8811A0h1NeOtztFRi7KVcc+zprvQvnJJyl/k86/l7f0RgLPee+6o9P37j0sI965aih0nr963P/O4FRpubeOX7Vz1ZQM7vXXbb6/daDsfOGna9Bbd6e8vcNODJkaLKVtcKpdBsajN2hd8zVgPvLhkHRO2HTZ4eC5O/abKjt9gWrLZxbKLwAA1YsEzdl3uHeE7qaXt6JGWwOy78THuxtFvu+oUNw9f1mm2g9U1IKrrb69PS1epeePcu5OqbJw59zxyHgxjQm/7bd0T0n7gSNVBW61br9WOvUudLibb/iudNb6a0l/sO7T+7T1PFh/xv6vIf1J9IbJ4KxXkY5VZANJ269DkAfh34238gTzBtpFWnqGnMtlqaUnQ3n6y1u6asn/fJKP76z8yZqfJ/1J+y9+fBSXSdk2/1gXmfjI0crsmJ/0++E01Kf8JOdvKX9C+ZF4kyj9/JslrXyWb3+o/On3Th8tzi/tx/I0JOWvXlfe86aNHI6ef68eP54YGOq56qOJeZGtr1ZRhu257v0RmW8pBce6fW93tsjsl6PeurXTTULUHKI9c+Zlq7zqWCw6/zXZ0iLeuvO1DCelL1BL+Uw7v6aV30D4/DGuhTkmcn6p4PyUNV8lbV/8+M9KX7bq6y8q7/m9tC3R33Ctv9bzhyrPv8qvHwCAdJGgWe9wt0xdd97hbh8Yki2X7d3ywWhXaT3x77keuxP/YSlA23HkPemZHSzO1yHcmq0XlAEpzTcBUkKLcqFwVa5PtWRWeiJ2vOpVb6bk+qgdr9bodZlKqOjkUY/t1wvqUOeEHN67V/YeHhHpea944ctav1FD+lX7wAGZsy1F5udDzda1pr/71FAx/S7a2mR6Gox/WHbBD3/ftOR4dW5tkQryIK17dDAv0oqlQ6QlK51WqOItadGWJjet1MRbqsx2ho4fVWv+Zwkf3+H1Z+VP3vxrHxgQsa11/u7Pf37Ia8eRA9I+dTkSnIW55r+I8uPK37zSzr9Z0spnrvLX3mN+W7fRL4eaRy2y5TV/diApf811ZX5CHPcxygQ3OecnPqq+RVR71njpK14ndrwtnS3+NeDul7PSUsdHVfxrkubLeFmg5xRPn1Vt+VRp59e08qvi54+9uqNDsq7vKu34VrUc/1npyyPt+Mvavrzn9+BY8rflYHE/pq2/1vNHPa4fAIBsxaBZT7x6J35+7gs7pZx2TyteyDQAC92J1xN/+CI3qrWIuPY9iZU8rSTtaZ+XkYulqNbcyXcs/8XcfGWVnte2SIv9mEZbANK6r2nlSB8NrvpiU+v2z4/I4T/aZ83vfimzdnKRY/2BStOv/7tZh9HRD+SdTUuytLRJ3vlg1Ez74J1NsvT6n4vL/Pl1b37KuFl+yZu26R35YHRURj94RzaF1hdePo2WMz9gKFVQtey+utUrn/auSNBS1RKv0a+g7j3t3u553xmspbIV+nAPD9OjInaDI9xTQiv+QUtcpcePS/j4Dq+/XiLrT9i+7PKbfnwG57CgHMS55r+o8lNr/qadf7Okls885c8792jx0nOveEFdsOjWUAKy8l9pWXW1dgWtbOPjfnCV96ZTHpEbwjluHnb39qQG+vH5ekNPAzkNnM22OVpz09RcPrOuDw5J54+4PNf3rOO72uM/T/rySDv+srYv3/n9tVLAHAt4c9WPMjjTX+P1AwCQT9kzzXm7mMXFX3YS7z6lFw2/lTChUmFagltMIFT8/pBXKXFUCs0Jf5Xc/Wii4mBE1WX7Z78sBgsaAB8P3clOXX9ItelvKF/MibaXBF3NtRKpRaJ9T+nOe9YNoHoKKrXVHjvmps78nERT+4XMJbTkJarw+GlEectvqu5e6RE/uEvkmL/a5WelZZbPWstfICv/Pf55S1tLB72gPypoZTOt2XZf1EOwP0tBZ3JvpWLA6w2mVTN2cyZrvj5Couk329bufmbZqdbymXJ9SGXOH7OSdvrKur7XKvv6WFn6krpXp0nbvrzn95aeAelpSQ7uVzT/6nX8AgBSlQXN4ZaDvPSicsR/aK3YPSip+5ReGP1KhX0RSnBhNHfFvYtNqOuTPyRf9Hf4V7BIhSWVaZVpl3rUwwp3zsnlqXY5cKTyfKrX9rs41x9SS/obgXZzGx/qlAnNq3iLo1ZUtUIy7t/tr2dLVR7VHDuG3gRo2SLR+o0+JzkvueK2OpWfFyqhIpyn/KYxrUEpXXqz5q92+VlpzvJZa/mzXPlrbtRltOyG+b0kBvJ3dU5iWt/m/WeDzedY0KvPj8Z6K2lLXvHYibUUqqz5AQ1Y3z2c/MxyUTh9ViOVT3ONtfJe3yOyAt0aj/9w+pRe1w4G+8YMyc/LJ8m7fVnnd73p4/eCij4+VFX+VaJOxy8AIF0xaK60S6K+Zbv07FX0RSjanepUyp3U4LcCwZ3/vN2GX/N+rJJWIH/9WueIXsx2Hj1ddnEzL9PIaCHQrlWRCpcJWqKBqHk2zdG9r9btzxJff1xZ+tcIfa5tqGdWBvdGXyjkd98rvZ3WDCmVWpeKu/1bxWOnJ/o24NzM843R8mOOr5zPgda7/Lhk5U8l+We6tzren+Aqv2nHp7bkVPtvphqh/ERaEr20fpjREhU9//p0O/yuz9FWtszyWWP5U2n569+o054Q+Z7B9pf38qPqly76/zaxJcgf0xI3Yp71DfavPvNbSSBfqbTnuMvSp9NeQPl0iu1/fX53qCf8QFNl13eVdnyrio7/zPTVKn37Kjm/+//hQ2KBc778q/b8UY/jFwCQLdLSnNV1t6x7mr1wmzvrg6XnucbHD8jcoFcpMXP1IhF/s6MX/OgLS94tdWMafdfeXQ4tk3Sn2a9ARO/Q5+G/REovZqVteE8uRiqduY1eFP2XKEGMYrZ/76DMht58abbPPl9Wz+1Pkmf9EbH0rwVaURrYqhXfd8sqWpr/F8Nd+4LB5l84f0xly7bYxPP37vn3Tb4MVdFFWFtJIt0LvSF4u2rW72ul7Pwfo+XHbGvwfGIOtZSfvLLyJ2u+6/xRcflNkPUSw7T5jVB+gtZV/d740Ba5rEGdnRdw5V8eaeWzHuUvK//1/Ov/myb/9/W55faUlkiTHy2lc5TeMDPp8mKN4huGI/kbXbc+Ex3kT2ILrgk0KnyhpIMGvNGuwbb8RvLPnT5VS/nMkuv88765OJrp4wfm5HCoJTTr+h7IKp/VHv9Z6atVnu1LO37i/GX9uob2lsibf9WeP2o9fr/++uvUAQDga2pubi4sLi7aUb9ycmDucMN2TdTuuUNbLldUYVwJ5m2aevGuoGLZSBop/aZlzXS5LrUgm7vxtnIZfoFKklq/j5WllWJ9QY6++XUl9oW/r/XNsNEeCIHM+ZSfmmTlL9Kt9fKZdXyv9PGP2mQFxl4d0X4CgLVJ49yPP/7YjlXu9ddfl127dpU/0zz6rn/HsqbnyVaI3y1rVgYraIFaKealL463+K4FDZX+pLebm2fecj6TVev3saZpS07aS4+y5lN+apOZv0hF+QQAoPGVBc2mK9HhEdla5fNkK8XcrT6g/yexvHsu1rbSc2Clrm/+y77ytVzV+n2sb5QfNDLKJwAAq6+sezYAAAAAAGvdinXPBgAAAAAAPoJmAAAAAAAcCJoBAAAAAHAgaAYAAAAAwIEXgQEAAAAAfnE0zl1YWLBj1eFFYAAAAAAApCBoBgAAAADAgaAZAAAAAAAHgmYAAAAAABwImgEAAAAAcCBoBgAAAADAgaAZAAAAAAAHgmYAAAAAABwImgEAAAAAcCBoBgAAAADAgaAZAAAAAAAHgmYAAAAAABwImgEAAAAAcCBoBgAAAADAgaAZAAAAAAAHgmYAAAAAABwImgEAAAAAcCBoBgAAAADAgaAZAAAAAAAHgmYAAAAAABwImgEAAAAASLB9+3aCZgAAAAAAkrz00ksEzQAAAAAAJPnss88ImgEAAAAAcCFoBgAAAADAgaAZAAAAAAAHgmYAAAAAABwImgEAAAAAcCBoBgAAAAAgkcj/A/VawW9vJLRTAAAAAElFTkSuQmCC" } }, "cell_type": "markdown", "metadata": {}, "source": [ "![win_setup_install_notebooks.png](attachment:win_setup_install_notebooks.png)\n", "\n", "By default, the notebooks will be saved in the directory `C:\\Users\\username\\gridappsd-training`\n", "\n", "Close the miniconda terminal" ] }, { "cell_type": "markdown", "metadata": {}, "source": [] }, { "cell_type": "markdown", "metadata": {}, "source": [ "---" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "### Running Python Training Notebooks" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "Start the Jupyter notebooks running on port 8890 (to avoid port sharing conflict with the GridAPPS-D Blazegraph database container):\n", "\n", "`jupyter notebook --port 8890`" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "\n", "\n", "If running on a remote server (e.g. AWS cloud or university / laboratory server farm), start the notebooks by running\n", "\n", "`jupyter notebook --port 8890 --no-browser --ip='0.0.0.0'`" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "### Port Sharing between GridAPPS-D and Jupyter\n", "\n", "By default, both Jupyter and the GridAPPS-D Blazegraph database use port 8889. If a Jupyter notebook is already running on port 8889, the Blazegraph database container will fail to start.\n", "\n", "It is recommended to specify manually that Jupyter run on a different port:\n", "\n", "`jupyter notebook --port 8890`" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "---" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "---" ] }, { "cell_type": "markdown", "metadata": {}, "source": [ "![gridappsd-logo](../../images/GridAPPS-D_narrow.png)" ] } ], "metadata": { "celltoolbar": "Tags", "kernelspec": { "display_name": "Python 3 (ipykernel)", "language": "python", "name": "python3" }, "language_info": { "codemirror_mode": { "name": "ipython", "version": 3 }, "file_extension": ".py", "mimetype": "text/x-python", "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", "version": "3.8.5" } }, "nbformat": 4, "nbformat_minor": 4 }