Skip to content

Commit

Permalink
Docs cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
andykee committed Jan 25, 2024
1 parent c974c05 commit b797394
Show file tree
Hide file tree
Showing 7 changed files with 158 additions and 148 deletions.
7 changes: 4 additions & 3 deletions docs/dev/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,14 @@ Install Lentil for development

Forking the Lentil repo
=======================
Matplotlib is hosted at `andykee/lentil.git <https://github.com/andykee/lentil>`_.
Lentil is hosted at `andykee/lentil.git <https://github.com/andykee/lentil>`_.
If you plan on solving issues or submitting pull requests to the main Lentil
repository, you should first fork this repository by visiting
`andykee/lentil.git <https://github.com/andykee/lentil>`_ and clicking on the
``Fork`` button on the top right of the page. See the
`GitHub documentation <https://docs.github.com/en/get-started/quickstart/fork-a-repo>`_
for more details.
`GitHub documentation
<https://docs.github.com/en/get-started/quickstart/fork-a-repo>`_ for more
details.

Installing from source
======================
Expand Down
2 changes: 1 addition & 1 deletion docs/dev/publishing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,4 @@ Upload the release
.. note::

Only core-team members are able to publish new releases to PyPi.
Only core dev team members are able to publish new releases to PyPi.
4 changes: 2 additions & 2 deletions docs/user/fundamentals/apertures.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ Aperture or mask shapes can be loaded from a file, created manually, or
constructed using one or more of Lentil's functions for drawing common
shapes in an array.

Core shapes
===========
Basic shapes
============
Lentil provides a number of functions for drawing basic shapes in arrays.
Multiple arrays can be combined to create more complicated shapes.

Expand Down
261 changes: 135 additions & 126 deletions docs/user/fundamentals/planes.rst

Large diffs are not rendered by default.

16 changes: 8 additions & 8 deletions docs/user/fundamentals/tilt.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
.. _user.fundamentals.tilt:

********************************
Working with large optical tilts
********************************
****************************************
Diffraction propagation with large tilts
****************************************


One of lentil's unique features is its hybrid approach to handling tilt.

The plane's :func:`~lentil.Plane.fit_tilt` method performs a least squares fit to
estimate and remove tilt from the :attr:`~lentil.Plane.opd` attribute. The removed
tilt is accounted for by appending an equivalent :class:`~lentil.Tilt` object to the
plane's :attr:`~lentil.Plane.tilt` attribute. The optical effect of the tilt is
automatically applied during a propagation step.
The plane's :func:`~lentil.Plane.fit_tilt` method performs a least squares fit
to estimate and remove tilt from the :attr:`~lentil.Plane.opd` attribute. The
removed tilt is accounted for by appending an equivalent :class:`~lentil.Tilt`
object to the plane's :attr:`~lentil.Plane.tilt` attribute. The optical effect
of the tilt is automatically applied during a propagation step.



Expand Down
2 changes: 1 addition & 1 deletion docs/user/fundamentals/wavefront_error.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ containing the JWST NITCam static wavefront error:
>>> import numpy as np
>>> import lentil
>>> opd = np.load('path/to/nircam_wfe.npy')
>>> opd = np.load('nircam_wfe.npy')
>>> pupil = lentil.Pupil(focal_length=119.77, pixelscale=6.6035/1024, opd=opd)
.. image:: /_static/img/nircam.png
Expand Down
14 changes: 7 additions & 7 deletions docs/user/getting_started/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ Installation
************

If you are new to Python and/or do not have familiarity with `Python virtual
environments <https://docs.python.org/3/tutorial/venv.html>`_, then we recommend
starting by installing the `Anaconda Distribution
<https://www.anaconda.com/download/>`_. This works on all platforms (linux,
Mac, Windows) and installs a full-featured scientific Python in a user directory
without requiring root permissions.
environments <https://docs.python.org/3/tutorial/venv.html>`_, then we
recommend starting by installing the `Anaconda Distribution
<https://www.anaconda.com/download/>`_. This works on all platforms (Linux,
MacOS, Windows) and installs a full-featured scientific Python in a user
directory without requiring root permissions.


Installing ``lentil``
=====================
Installing Lentil
=================
To install using **pip**:

.. code-block:: bash
Expand Down

0 comments on commit b797394

Please sign in to comment.