tutorials/03-Python-modules.ipynb

   1 {
   2   "nbformat": 4,
   3   "nbformat_minor": 0,
   4   "metadata": {
   5     "anaconda-cloud": {},
   6     "colab": {
   7       "name": "03-Python-modules.ipynb",
   8       "provenance": [],
   9       "collapsed_sections": []
  10     },
  11     "kernelspec": {
  12       "display_name": "Python 3",
  13       "language": "python",
  14       "name": "python3"
  15     },
  16     "language_info": {
  17       "codemirror_mode": {
  18         "name": "ipython",
  19         "version": 3
  20       },
  21       "file_extension": ".py",
  22       "mimetype": "text/x-python",
  23       "name": "python",
  24       "nbconvert_exporter": "python",
  25       "pygments_lexer": "ipython3",
  26       "version": "3.8.5"
  27     }
  28   },
  29   "cells": [
  30     {
  31       "cell_type": "markdown",
  32       "metadata": {
  33         "id": "cB27OQ9zJ5iV"
  34       },
  35       "source": [
  36         "# Python Tutorial III: Modules\n",
  37         "In this lecture, we will see how to make code more organized by creating user-defined modules and split the code into multiple reusable parts."
  38       ]
  39     },
  40     {
  41       "cell_type": "markdown",
  42       "metadata": {
  43         "collapsed": true,
  44         "id": "E9MCM1FZ7RzB"
  45       },
  46       "source": [
  47         "## Modules\n",
  48         "\n",
  49         "### What is it?\n",
  50         "* A file containing Python definitions and statements.\n",
  51         "* The file name is the module name with the suffix .py appended.\n",
  52         "* Within a module, the module's name is available as the valuable of the global variable *__name__*.\n",
  53         "\n",
  54         "### When to use:\n",
  55         "* Your script gets very long and you want to have easier maintenance. \n",
  56         "* You want to reuse a function in several programs or scripts without copy/paste.\n",
  57         "* Performance reasons.\n",
  58         "\n",
  59         "Let's look at an example:\n",
  60         "\n",
  61         "Let's get file ``differences.py`` "
  62       ]
  63     },
  64     {
  65       "cell_type": "code",
  66       "metadata": {
  67         "id": "PtMqI_JXeVNX"
  68       },
  69       "source": [
  70         "# copy from github raw url if we do not have the file already\n",
  71         "import os\n",
  72         "if not os.path.exists('differences.py'):\n",
  73         "    use the shell escale ! to run the command wget and copy the file at https://raw.githubusercontent.com/janmandel/CCM-Intro-to-SC/main/differences.py to your runtime contents\n",
  74         "else:\n",
  75         "    print('file already exists')\n",
  76         "\n",
  77         "\n"
  78       ],
  79       "execution_count": null,
  80       "outputs": []
  81     },
  82     {
  83       "cell_type": "code",
  84       "metadata": {
  85         "id": "alToqvR87SDN"
  86       },
  87       "source": [
  88         "# and import it\n",
  89         "import differences as diff # We import the module just like we import numpy\n",
  90         "print('if we got here the import went OK')\n"
  91       ],
  92       "execution_count": null,
  93       "outputs": []
  94     },
  95     {
  96       "cell_type": "code",
  97       "metadata": {
  98         "id": "dcXJbaiQ7RzB"
  99       },
 100       "source": [
 101         "# magic to make the output appear here https://pythonguides.com/what-is-matplotlib-inline/\n",
 102         "%matplotlib inline   \n",
 103         "\n",
 104         "import matplotlib.pyplot as plt\n",
 105         "import numpy as np\n",
 106         "\n",
 107         "# code a functkon and its derivative\n",
 108         "def myfun(x=0):\n",
 109         "    return np.exp(-x**2)*np.sin(np.pi*x)\n",
 110         "\n",
 111         "def myder(x=0):\n",
 112         "    return np.exp(-x**2)*(np.pi*np.cos(np.pi*x)-2*x*np.sin(np.pi*x))\n"
 113       ],
 114       "execution_count": null,
 115       "outputs": []
 116     },
 117     {
 118       "cell_type": "code",
 119       "metadata": {
 120         "id": "bXYDve3f5WCC"
 121       },
 122       "source": [
 123         "# make a figure number 0\n",
 124         "plt.figure(0)\n",
 125         "plt.plot(x,myfun(x))\n",
 126         "plt.title('$f(x) = e^{-x^2}\\sin(\\pi x)$')"
 127       ],
 128       "execution_count": null,
 129       "outputs": []
 130     },
 131     {
 132       "cell_type": "code",
 133       "metadata": {
 134         "id": "cs6RdpFb7RzB"
 135       },
 136       "source": [
 137         "# now compute numerical derivatives \n",
 138         "\n",
 139         "# make mesh of points on x axis\n",
 140         "x = np.linspace(0,1,100)  \n",
 141         "\n",
 142         "fprime_FD = diff.for_diff(myfun,x,.1) #array of forward difference approximation to the derivative\n",
 143         "\n",
 144         "# remember the figure objects as variable\n",
 145         "fig1 = plt.figure(1, figsize=(15, 6)) # for plots of forward difference approx\n",
 146         "\n",
 147         "axes1_1 = fig1.add_subplot(1, 2, 1) #the first plot in a 1x2 array\n",
 148         "axes2_1 = fig1.add_subplot(1, 2, 2) #the second plot in a 1x2 array\n",
 149         "\n",
 150         "axes1_1.plot(x,myder(x),label='$f^\\prime$')\n",
 151         "axes1_1.plot(x,fprime_FD,label='FD approx of $f^\\prime$')\n",
 152         "axes1_1.legend(loc='upper right', fontsize=14)\n",
 153         "\n",
 154         "axes2_1.plot(x,myder(x)-fprime_FD)\n",
 155         "axes2_1.set_title('Error in the approximate forward derivative')\n"
 156       ],
 157       "execution_count": null,
 158       "outputs": []
 159     },
 160     {
 161       "cell_type": "code",
 162       "metadata": {
 163         "id": "tcQWbwCB8w24"
 164       },
 165       "source": [
 166         "# compute and plot the same for backward difference approximation to the derivative\n",
 167         "# use new variables for the figure and axes, do not reuse\n",
 168         "# can reuse array x\n",
 169         "fig2 = plt.figure(2, figsize=(15, 6)) # for plots of backward difference approx\n",
 170         "\n",
 171         "fprime_BD = diff.back_diff(myfun,x,.1) #backward difference approximation to the derivative\n",
 172         "axes1_1b = fig2.add_subplot(1, 2, 1) #the first plot in a 1x2 array\n",
 173         "axes2_1b = fig2.add_subplot(1, 2, 2) #the second plot in a 1x2 array\n",
 174         "\n",
 175         "axes1_1b.plot(x,myder(x),label='$f^\\prime$')\n",
 176         "axes1_1b.plot(x,fprime_BD,label='BD approx of $f^\\prime$')\n",
 177         "axes1_1b.legend(loc='upper right', fontsize=14)\n",
 178         "\n",
 179         "axes2_1b.plot(x,myder(x)-fprime_BD)\n",
 180         "axes2_1b.set_title('Error in the approximate backward derivative')\n",
 181         "\n"
 182       ],
 183       "execution_count": null,
 184       "outputs": []
 185     },
 186     {
 187       "cell_type": "code",
 188       "metadata": {
 189         "id": "fzE3346E91Ct"
 190       },
 191       "source": [
 192         "# compute and plot the same for central difference approximation to the derivative\n",
 193         "# use new variable for the figure, do not reuse\n",
 194         "# can reuse array x\n",
 195         "your code here\n"
 196       ],
 197       "execution_count": null,
 198       "outputs": []
 199     },
 200     {
 201       "cell_type": "markdown",
 202       "metadata": {
 203         "id": "-8ECd_LhBNvM"
 204       },
 205       "source": [
 206         "## Look at the pictures and print below which numerical derivative is most accurate: forward, backward, or central?## "
 207       ]
 208     },
 209     {
 210       "cell_type": "code",
 211       "metadata": {
 212         "id": "GaqBob_2Bxfx"
 213       },
 214       "source": [
 215         "your code"
 216       ],
 217       "execution_count": null,
 218       "outputs": []
 219     },
 220     {
 221       "cell_type": "markdown",
 222       "metadata": {
 223         "collapsed": true,
 224         "id": "0Ia7JMMS7RzB"
 225       },
 226       "source": [
 227         "## Where does a module file need to go?\n",
 228         "\n",
 229         "Say you are trying to `import spam`.\n",
 230         "\n",
 231         "When importing, the interpreter searches for spam in locations in the list of directories given by the variable *sys.path*.\n",
 232         "On Colab, this includes the directory /contents, which is your running directory.\n",
 233         "\n"
 234       ]
 235     },
 236     {
 237       "cell_type": "markdown",
 238       "metadata": {
 239         "id": "JnOf1Q2_I1zq"
 240       },
 241       "source": [
 242         "##Exercise: import the package sys and print the variable sys.path"
 243       ]
 244     },
 245     {
 246       "cell_type": "code",
 247       "metadata": {
 248         "id": "XQHqQc9tIUHB"
 249       },
 250       "source": [
 251         "your code here"
 252       ],
 253       "execution_count": null,
 254       "outputs": []
 255     },
 256     {
 257       "cell_type": "markdown",
 258       "metadata": {
 259         "id": "TlyxPtJNIXHj"
 260       },
 261       "source": [
 262         "## Generalizations of Modules: Packages\n",
 263         "\n",
 264         "Packages (i.e., libraries) are modules with a *directory* structure.\n",
 265         "You can even make packages with subpackages and simply exploit the dot.dot reference to navigate through the package to get to the function you want (e.g. matplotlib.pyplot.plot).  \n",
 266         "If you want to develop a well-comparmentalized package you can look at online help: https://python-packaging.readthedocs.io/en/latest/"
 267       ]
 268     }
 269   ]
 270 }