Merge branch 'main' of https://github.com/Jashcraf/poke into main

Jashcraf · Sep 25, 2023 · 3f0b410 · 3f0b410
2 parents d45bd6c + 6fb60e2
commit 3f0b410
Show file tree

Hide file tree

Showing 30 changed files with 1,483 additions and 59 deletions.
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/index.doctree b/docs/_build/doctrees/index.doctree
diff --git a/docs/_build/doctrees/nbsphinx/notebooks/using_ipython.ipynb b/docs/_build/doctrees/nbsphinx/notebooks/using_ipython.ipynb
diff --git a/docs/_build/doctrees/nbsphinx/notebooks_using_ipython_11_0.png b/docs/_build/doctrees/nbsphinx/notebooks_using_ipython_11_0.png
diff --git a/docs/_build/doctrees/nbsphinx/notebooks_using_ipython_7_0.png b/docs/_build/doctrees/nbsphinx/notebooks_using_ipython_7_0.png
diff --git a/docs/_build/doctrees/notebooks/using_ipython.doctree b/docs/_build/doctrees/notebooks/using_ipython.doctree
diff --git a/docs/_build/doctrees/poke.doctree b/docs/_build/doctrees/poke.doctree
diff --git a/docs/_build/html/.buildinfo b/docs/_build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: aa8cabf50016a8722cd86db3119b7bd3
+config: ecf31bd4186801db94ddb112786b82f7
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/_build/html/_images/notebooks_using_ipython_11_0.png b/docs/_build/html/_images/notebooks_using_ipython_11_0.png
diff --git a/docs/_build/html/_images/notebooks_using_ipython_7_0.png b/docs/_build/html/_images/notebooks_using_ipython_7_0.png
diff --git a/docs/_build/html/_sources/index.rst.txt b/docs/_build/html/_sources/index.rst.txt
@@ -23,6 +23,7 @@ Summary
    poke
    notebooks/installation.ipynb
    notebooks/rayfrontattributes.ipynb
+   notebooks/using_ipython.ipynb
    notebooks/introtopolarization.ipynb
    notebooks/jonespupils.ipynb
    notebooks/thinfilm_optimization.ipynb

diff --git a/docs/_build/html/_sources/notebooks/using_ipython.ipynb.txt b/docs/_build/html/_sources/notebooks/using_ipython.ipynb.txt
diff --git a/docs/_build/html/genindex.html b/docs/_build/html/genindex.html
@@ -40,6 +40,7 @@
 <li class="toctree-l1"><a class="reference internal" href="poke.html">poke package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks/installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks/rayfrontattributes.html">Intro to Poke: The Rayfront</a></li>
+<li class="toctree-l1"><a class="reference internal" href="notebooks/using_ipython.html">Using Jupyter Notebooks &amp; Raytracer Specifics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks/introtopolarization.html">Intro to Poke: Polarization Ray Tracing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks/jonespupils.html">Generating a Jones Pupil and propagating it with HCIPy &amp; Poppy</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks/thinfilm_optimization.html">Simulating Multilayer Thin Films</a></li>

diff --git a/docs/_build/html/index.html b/docs/_build/html/index.html
@@ -42,6 +42,7 @@
 <li class="toctree-l1"><a class="reference internal" href="poke.html">poke package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks/installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks/rayfrontattributes.html">Intro to Poke: The Rayfront</a></li>
+<li class="toctree-l1"><a class="reference internal" href="notebooks/using_ipython.html">Using Jupyter Notebooks &amp; Raytracer Specifics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks/introtopolarization.html">Intro to Poke: Polarization Ray Tracing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks/jonespupils.html">Generating a Jones Pupil and propagating it with HCIPy &amp; Poppy</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks/thinfilm_optimization.html">Simulating Multilayer Thin Films</a></li>
@@ -130,6 +131,11 @@ <h2>Summary<a class="headerlink" href="#summary" title="Permalink to this headli
 <li class="toctree-l2"><a class="reference internal" href="notebooks/rayfrontattributes.html#Displaying-Footprint-Diagrams-and-Ray-OPDs">Displaying Footprint Diagrams and Ray OPDs</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="notebooks/using_ipython.html">Using Jupyter Notebooks &amp; Raytracer Specifics</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="notebooks/using_ipython.html#Ansys-Zemax-OpticStudio">Ansys Zemax OpticStudio</a></li>
+<li class="toctree-l2"><a class="reference internal" href="notebooks/using_ipython.html#SYNOPSYS-CODE-V">SYNOPSYS CODE V</a></li>
+</ul>
+</li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks/introtopolarization.html">Intro to Poke: Polarization Ray Tracing</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="notebooks/introtopolarization.html#Initializing-a-Rayfront-as-Polarized">Initializing a Rayfront as Polarized</a></li>
 </ul>

diff --git a/docs/_build/html/modules.html b/docs/_build/html/modules.html
@@ -18,9 +18,7 @@
         <script crossorigin="anonymous" integrity="sha256-Ae2Vz/4ePdIu6ZyI/5ZGsYnb+m0JlOmKPjt6XZ9JJkA=" src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.4/require.min.js"></script>
     <script src="_static/js/theme.js"></script>
     <link rel="index" title="Index" href="genindex.html" />
-    <link rel="search" title="Search" href="search.html" />
-    <link rel="next" title="poke package" href="poke.html" />
-    <link rel="prev" title="Welcome to poke’s documentation!" href="index.html" /> 
+    <link rel="search" title="Search" href="search.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -39,13 +37,11 @@
 </div>
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption"><span class="caption-text">Contents:</span></p>
-<ul class="current">
-<li class="toctree-l1 current"><a class="current reference internal" href="#">poke</a><ul>
-<li class="toctree-l2"><a class="reference internal" href="poke.html">poke package</a></li>
-</ul>
-</li>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="poke.html">poke package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks/installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks/rayfrontattributes.html">Intro to Poke: The Rayfront</a></li>
+<li class="toctree-l1"><a class="reference internal" href="notebooks/using_ipython.html">Using Jupyter Notebooks &amp; Raytracer Specifics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks/introtopolarization.html">Intro to Poke: Polarization Ray Tracing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks/jonespupils.html">Generating a Jones Pupil and propagating it with HCIPy &amp; Poppy</a></li>
 <li class="toctree-l1"><a class="reference internal" href="notebooks/thinfilm_optimization.html">Simulating Multilayer Thin Films</a></li>
@@ -123,10 +119,7 @@ <h1>poke<a class="headerlink" href="#poke" title="Permalink to this headline">
 
            </div>
           </div>
-          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="index.html" class="btn btn-neutral float-left" title="Welcome to poke’s documentation!" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-        <a href="poke.html" class="btn btn-neutral float-right" title="poke package" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
-    </div>
+          <footer>
 
   <hr/>
 

diff --git a/docs/_build/html/notebooks/aboutpoke.html b/docs/_build/html/notebooks/aboutpoke.html
@@ -41,9 +41,10 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="../modules.html">poke</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../poke.html">poke package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="rayfrontattributes.html">Intro to Poke: The Rayfront</a></li>
+<li class="toctree-l1"><a class="reference internal" href="using_ipython.html">Using Jupyter Notebooks &amp; Raytracer Specifics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="introtopolarization.html">Intro to Poke: Polarization Ray Tracing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="jonespupils.html">Generating a Jones Pupil and propagating it with HCIPy &amp; Poppy</a></li>
 <li class="toctree-l1"><a class="reference internal" href="thinfilm_optimization.html">Simulating Multilayer Thin Films</a></li>

diff --git a/docs/_build/html/notebooks/arm_generation.html b/docs/_build/html/notebooks/arm_generation.html
@@ -40,9 +40,10 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../modules.html">poke</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../poke.html">poke package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="rayfrontattributes.html">Intro to Poke: The Rayfront</a></li>
+<li class="toctree-l1"><a class="reference internal" href="using_ipython.html">Using Jupyter Notebooks &amp; Raytracer Specifics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="introtopolarization.html">Intro to Poke: Polarization Ray Tracing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="jonespupils.html">Generating a Jones Pupil and propagating it with HCIPy &amp; Poppy</a></li>
 <li class="toctree-l1"><a class="reference internal" href="thinfilm_optimization.html">Simulating Multilayer Thin Films</a></li>

diff --git a/docs/_build/html/notebooks/installation.html b/docs/_build/html/notebooks/installation.html
@@ -42,12 +42,13 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="../modules.html">poke</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../poke.html">poke package</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#Requirements">Requirements</a></li>
 </ul>
 </li>
 <li class="toctree-l1"><a class="reference internal" href="rayfrontattributes.html">Intro to Poke: The Rayfront</a></li>
+<li class="toctree-l1"><a class="reference internal" href="using_ipython.html">Using Jupyter Notebooks &amp; Raytracer Specifics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="introtopolarization.html">Intro to Poke: Polarization Ray Tracing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="jonespupils.html">Generating a Jones Pupil and propagating it with HCIPy &amp; Poppy</a></li>
 <li class="toctree-l1"><a class="reference internal" href="thinfilm_optimization.html">Simulating Multilayer Thin Films</a></li>

diff --git a/docs/_build/html/notebooks/introtopolarization.html b/docs/_build/html/notebooks/introtopolarization.html
@@ -22,7 +22,7 @@
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
     <link rel="next" title="Generating a Jones Pupil and propagating it with HCIPy &amp; Poppy" href="jonespupils.html" />
-    <link rel="prev" title="Intro to Poke: The Rayfront" href="rayfrontattributes.html" /> 
+    <link rel="prev" title="Using Jupyter Notebooks &amp; Raytracer Specifics" href="using_ipython.html" /> 
 </head>
 
 <body class="wy-body-for-nav"> 
@@ -42,9 +42,10 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="../modules.html">poke</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../poke.html">poke package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="rayfrontattributes.html">Intro to Poke: The Rayfront</a></li>
+<li class="toctree-l1"><a class="reference internal" href="using_ipython.html">Using Jupyter Notebooks &amp; Raytracer Specifics</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Intro to Poke: Polarization Ray Tracing</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#Initializing-a-Rayfront-as-Polarized">Initializing a Rayfront as Polarized</a></li>
 </ul>
@@ -531,7 +532,7 @@ <h2>Initializing a Rayfront as Polarized<a class="headerlink" href="#Initializin
            </div>
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
-        <a href="rayfrontattributes.html" class="btn btn-neutral float-left" title="Intro to Poke: The Rayfront" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
+        <a href="using_ipython.html" class="btn btn-neutral float-left" title="Using Jupyter Notebooks &amp; Raytracer Specifics" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
         <a href="jonespupils.html" class="btn btn-neutral float-right" title="Generating a Jones Pupil and propagating it with HCIPy &amp; Poppy" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 

diff --git a/docs/_build/html/notebooks/jonespupils.html b/docs/_build/html/notebooks/jonespupils.html
@@ -42,9 +42,10 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="../modules.html">poke</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../poke.html">poke package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="rayfrontattributes.html">Intro to Poke: The Rayfront</a></li>
+<li class="toctree-l1"><a class="reference internal" href="using_ipython.html">Using Jupyter Notebooks &amp; Raytracer Specifics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="introtopolarization.html">Intro to Poke: Polarization Ray Tracing</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Generating a Jones Pupil and propagating it with HCIPy &amp; Poppy</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#Now-Let’s-Compute-a-Jones-Pupil-using-our-data-from-above">Now Let’s Compute a Jones Pupil using our data from above</a></li>

diff --git a/docs/_build/html/notebooks/rayfrontattributes.html b/docs/_build/html/notebooks/rayfrontattributes.html
@@ -21,7 +21,7 @@
     <script src="../_static/js/theme.js"></script>
     <link rel="index" title="Index" href="../genindex.html" />
     <link rel="search" title="Search" href="../search.html" />
-    <link rel="next" title="Intro to Poke: Polarization Ray Tracing" href="introtopolarization.html" />
+    <link rel="next" title="Using Jupyter Notebooks &amp; Raytracer Specifics" href="using_ipython.html" />
     <link rel="prev" title="Installation" href="installation.html" /> 
 </head>
 
@@ -42,12 +42,13 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="../modules.html">poke</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../poke.html">poke package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Intro to Poke: The Rayfront</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#Displaying-Footprint-Diagrams-and-Ray-OPDs">Displaying Footprint Diagrams and Ray OPDs</a></li>
 </ul>
 </li>
+<li class="toctree-l1"><a class="reference internal" href="using_ipython.html">Using Jupyter Notebooks &amp; Raytracer Specifics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="introtopolarization.html">Intro to Poke: Polarization Ray Tracing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="jonespupils.html">Generating a Jones Pupil and propagating it with HCIPy &amp; Poppy</a></li>
 <li class="toctree-l1"><a class="reference internal" href="thinfilm_optimization.html">Simulating Multilayer Thin Films</a></li>
@@ -481,7 +482,7 @@ <h2>Displaying Footprint Diagrams and Ray OPDs<a class="headerlink" href="#Displ
           </div>
           <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
         <a href="installation.html" class="btn btn-neutral float-left" title="Installation" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
-        <a href="introtopolarization.html" class="btn btn-neutral float-right" title="Intro to Poke: Polarization Ray Tracing" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
+        <a href="using_ipython.html" class="btn btn-neutral float-right" title="Using Jupyter Notebooks &amp; Raytracer Specifics" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
     </div>
 
   <hr/>

diff --git a/docs/_build/html/notebooks/spiefigures.html b/docs/_build/html/notebooks/spiefigures.html
@@ -40,9 +40,10 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
-<li class="toctree-l1"><a class="reference internal" href="../modules.html">poke</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../poke.html">poke package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="rayfrontattributes.html">Intro to Poke: The Rayfront</a></li>
+<li class="toctree-l1"><a class="reference internal" href="using_ipython.html">Using Jupyter Notebooks &amp; Raytracer Specifics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="introtopolarization.html">Intro to Poke: Polarization Ray Tracing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="jonespupils.html">Generating a Jones Pupil and propagating it with HCIPy &amp; Poppy</a></li>
 <li class="toctree-l1"><a class="reference internal" href="thinfilm_optimization.html">Simulating Multilayer Thin Films</a></li>

diff --git a/docs/_build/html/notebooks/thinfilm_optimization.html b/docs/_build/html/notebooks/thinfilm_optimization.html
@@ -42,9 +42,10 @@
         </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
               <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul class="current">
-<li class="toctree-l1"><a class="reference internal" href="../modules.html">poke</a></li>
+<li class="toctree-l1"><a class="reference internal" href="../poke.html">poke package</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
 <li class="toctree-l1"><a class="reference internal" href="rayfrontattributes.html">Intro to Poke: The Rayfront</a></li>
+<li class="toctree-l1"><a class="reference internal" href="using_ipython.html">Using Jupyter Notebooks &amp; Raytracer Specifics</a></li>
 <li class="toctree-l1"><a class="reference internal" href="introtopolarization.html">Intro to Poke: Polarization Ray Tracing</a></li>
 <li class="toctree-l1"><a class="reference internal" href="jonespupils.html">Generating a Jones Pupil and propagating it with HCIPy &amp; Poppy</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Simulating Multilayer Thin Films</a></li>