add thin film notebook to docs

tfrizzly · Feb 3, 2021 · 5d9953c · 5d9953c
1 parent 64e5e2f
commit 5d9953c
Show file tree

Hide file tree

Showing 6 changed files with 11 additions and 10 deletions.
diff --git a/docs/source/examples.rst b/docs/source/examples.rst
@@ -7,3 +7,4 @@ Examples
    :maxdepth: 1
 
    examples/01_quick_start.ipynb
+   examples/02_thinfilm.ipynb
diff --git a/examples/01_quick_start.ipynb b/examples/01_quick_start.ipynb
@@ -838,9 +838,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python [conda env:thinfilmjax]",
+   "display_name": "",
    "language": "python",
-   "name": "conda-env-thinfilmjax-py"
+   "name": ""
   },
   "language_info": {
    "codemirror_mode": {

diff --git a/examples/02_thinfilm.ipynb b/examples/02_thinfilm.ipynb
@@ -28,16 +28,13 @@
     "import matplotlib.pyplot as plt\n",
     "\n",
     "# GPU setup\n",
-    "#%env XLA_FLAGS=--xla_gpu_cuda_data_dir=path/to/cuda\n",
-    "%env XLA_FLAGS=--xla_gpu_cuda_data_dir=/usr/local/cuda-10.0\n",
+    "#%env XLA_FLAGS=--xla_gpu_cuda_data_dir=/path/to/cuda\n",
     "\n",
     "import jax\n",
     "import jax.numpy as jnp\n",
     "import jax.experimental.optimizers as opt\n",
     "\n",
     "# sax circuit simulator\n",
-    "import sys\n",
-    "sys.path.append(\"..\")\n",
     "import sax"
    ]
   },
@@ -660,7 +657,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# Wavelength-dependent Fabry-Pérot étalon\n",
+    "## Wavelength-dependent Fabry-Pérot étalon\n",
     "\n",
     "Let's repeat with a model where parameters can be wavelength-dependent. To comply with the optimizer object, we will stack all design parameters in a single array :"
    ]
@@ -923,9 +920,9 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "thinfilmjax",
+   "display_name": "",
    "language": "python",
-   "name": "thinfilmjax"
+   "name": ""
   },
   "language_info": {
    "codemirror_mode": {

diff --git a/requirements.txt b/requirements.txt
@@ -7,3 +7,4 @@ matplotlib
 sphinx
 nbsphinx
 sphinx-rtd-theme
+tmm
diff --git a/sax/__init__.py b/sax/__init__.py
@@ -1,7 +1,7 @@
 """ SAX """
 
 __author__ = "Floris Laporte"
-__version__ = "0.0.0"
+__version__ = "0.0.1"
 
 
 from . import core

diff --git a/sax/models/__init__.py b/sax/models/__init__.py
@@ -0,0 +1,2 @@
+from . import pic
+from . import thinfilm
Original file line number	Diff line number	Diff line change
Expand Up		@@ -7,3 +7,4 @@ Examples
		:maxdepth: 1

		examples/01_quick_start.ipynb
		examples/02_thinfilm.ipynb
-Original file line number
+Diff line change
@@ Expand Up / @@ -7,3 +7,4 @@ matplotlib @@
     sphinx
     nbsphinx
     sphinx-rtd-theme
+    tmm