Merge branch 'docs'

andykee · Nov 29, 2023 · ec111ea · ec111ea
2 parents 1c62130 + 1572afb
commit ec111ea
Show file tree

Hide file tree

Showing 106 changed files with 2,102 additions and 1,566 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -45,7 +45,11 @@ jobs:
         uses: actions/upload-pages-artifact@v2
         with:
           # Upload entire repository
+<<<<<<< HEAD
           path: 'docs/_build/html'
+=======
+          path: '_build/html'
+>>>>>>> docs
       - name: Deploy to GitHub Pages
         id: deployment
         uses: actions/deploy-pages@v2
diff --git a/.gitignore b/.gitignore
@@ -57,7 +57,7 @@ cover/
 
 # Sphinx documentation
 docs/_build/
-docs/generated
+docs/ref/generated
 
 # PyBuilder
 .pybuilder/

diff --git a/docs/Makefile b/docs/Makefile
@@ -16,7 +16,7 @@ help:
 
 clean:
 	-rm -rf $(BUILDDIR)
-	-rm -rf generated
+	-rm -rf ref/generated
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).

diff --git a/docs/_img/logo/Metropolis-Light.otf b/docs/_img/logo/Metropolis-Light.otf
diff --git a/docs/_img/logo/favicon.tex b/docs/_img/logo/favicon.tex
@@ -0,0 +1,17 @@
+\documentclass[tikz, margin=0mm]{standalone}
+\definecolor{nord}{HTML}{3B4252}
+
+\begin{document}
+\begin{tikzpicture}
+
+\def \w {1.5mm}
+
+\draw[fill, nord](0,0) circle (2mm);
+\node[draw, circle, nord, line width=\w, minimum size=0.65cm] at (0, 0) {};
+\node[draw, circle, nord, line width=\w, minimum size=1.025cm] at (0, 0) {};
+\node[draw, circle, nord, line width=\w, minimum size=1.4cm] at (0, 0) {};
+\node[draw, circle, nord, line width=\w, minimum size=1.775cm] at (0, 0) {};
+\node[draw, circle, nord, line width=\w, minimum size=2.15cm] at (0, 0) {};
+
+\end{tikzpicture}
+\end{document}
diff --git a/docs/_img/logo/logo-dark.tex b/docs/_img/logo/logo-dark.tex
@@ -0,0 +1,11 @@
+\documentclass[tikz, margin=0mm]{standalone}
+%\usepackage{tikz}
+%\usetikzlibrary{calc}
+
+\usepackage{fontspec}
+\setmainfont{Metropolis-Light.otf}
+\definecolor{nord}{HTML}{E5E9F0}
+
+\begin{document}
+\include{logo.tex}
+\end{document}
diff --git a/docs/_img/logo/logo-light.tex b/docs/_img/logo/logo-light.tex
@@ -0,0 +1,11 @@
+\documentclass[tikz, margin=0mm]{standalone}
+%\usepackage{tikz}
+%\usetikzlibrary{calc}
+
+\usepackage{fontspec}
+\setmainfont{Metropolis-Light.otf}
+\definecolor{nord}{HTML}{3B4252}
+
+\begin{document}
+\include{logo.tex}
+\end{document}
diff --git a/docs/_img/logo/logo.sh b/docs/_img/logo/logo.sh
@@ -0,0 +1,12 @@
+#!/bin/sh
+
+# note: this requires poppler to be installed (brew install poppler)
+xelatex logo-dark.tex
+pdftocairo -svg logo-dark.pdf logo-dark.svg
+
+xelatex logo-light.tex
+pdftocairo -svg logo-light.pdf logo-light.svg
+
+rm *.pdf
+rm *.log
+rm *.aux
diff --git a/docs/_img/logo/logo.tex b/docs/_img/logo/logo.tex
@@ -0,0 +1,15 @@
+\begin{tikzpicture}
+
+\def \w {1.5mm}
+
+\draw[fill, nord](0,0) circle (2mm);
+\draw[fill, white] (-1.5,0) circle (0.01mm); % pad left edge
+\node[draw, circle, nord, line width=\w, minimum size=0.65cm] at (0, 0) {};
+\node[draw, circle, nord, line width=\w, minimum size=1.025cm] at (0, 0) {};
+\node[draw, circle, nord, line width=\w, minimum size=1.4cm] at (0, 0) {};
+\node[draw, circle, nord, line width=\w, minimum size=1.775cm] at (0, 0) {};
+\node[draw, circle, nord, line width=\w, minimum size=2.15cm] at (0, 0) {};
+\node [scale=6, right, nord, inner sep=1pt] at (2,0) {L E N T I L};
+%\node [scale=9, right, nord] at (1.25,0) {L E N T I L};
+
+\end{tikzpicture}
diff --git a/docs/_img/python/focus_images.py b/docs/_img/python/focus_images.py
diff --git a/docs/_img/python/jitter.py b/docs/_img/python/jitter.py
@@ -9,7 +9,7 @@
 pupil = lentil.Pupil(amplitude=mask, phase=phase, focal_length=10, pixelscale=1 / 240)
 w = lentil.Wavefront(650e-9)
 w *= pupil
-w = w.propagate_image(pixelscale=5e-6, npix=64, oversample=5)
+w = lentil.propagate_dft(w, pixelscale=5e-6, shape=64, oversample=5)
 psf = w.intensity
 
 psf_jitter = lentil.jitter(psf, scale=2, oversample=5)

diff --git a/docs/_img/python/npix_prop.py b/docs/_img/python/npix_prop.py
diff --git a/docs/_img/python/pixelate.py b/docs/_img/python/pixelate.py
@@ -9,7 +9,7 @@
 pupil = lentil.Pupil(amplitude=mask, phase=phase, focal_length=10, pixelscale=1 / 240)
 w = lentil.Wavefront(650e-9)
 w *= pupil
-w = w.propagate_image(pixelscale=5e-6, npix=64, oversample=5)
+w = lentil.propagate_dft(w, pixelscale=5e-6, shape=64, oversample=5)
 psf = w.intensity
 
 psf_pixelate = lentil.detector.pixelate(psf, oversample=5)

diff --git a/docs/_img/python/smear.py b/docs/_img/python/smear.py
@@ -9,7 +9,7 @@
 pupil = lentil.Pupil(amplitude=mask, phase=phase, focal_length=10, pixelscale=1 / 240)
 w = lentil.Wavefront(650e-9)
 w *= pupil
-w = w.propagate_image(pixelscale=5e-6, npix=64, oversample=5)
+w = lentil.propagate_dft(w, pixelscale=5e-6, shape=64, oversample=5)
 psf = w.intensity
 
 psf_smear = lentil.smear(psf, distance=5e-5,

diff --git a/docs/_img/python/smear_directional.py b/docs/_img/python/smear_directional.py
@@ -9,7 +9,7 @@
 pupil = lentil.Pupil(amplitude=mask, phase=phase, focal_length=10, pixelscale=1 / 240)
 w = lentil.Wavefront(650e-9)
 w *= pupil
-w = w.propagate_image(pixelscale=5e-6, npix=64, oversample=5)
+w = lentil.propagate_dft(w, pixelscale=5e-6, shape=64, oversample=5)
 psf = w.intensity
 
 psf_smear = lentil.smear(psf, distance=25, angle=30,

diff --git a/docs/_img/python/tilt_images.py b/docs/_img/python/tilt_images.py