Welcome to the OTT documentation!

This website provides documentation for the Optical Tweezers Toolbox (OTT). Use the table of contents bellow to navigate to a chapter in the documentation. The documentation can also be downloaded in PDF format. Alternatively, the restructured text (ReST) used to generate this documentation can be found in the docs directory and viewed using a regular text editor.

Table of Contents

• Introduction
  • About
  • Dependencies
  • Licence
  • Contributing
  • Contact us
• Getting Started
  • Installation
  • Using the graphical user interface
  • Using the toolbox functions
• Examples
  • ottBeams Example : Creating and visualising beams
  • ottParticles Example : Creating and using particles
  • ottForce Example : Calculate and visualise force
  • Advanced examples
  • Calculating forces with the GUI
• Reference
  • beam Package
  • particle Package
  • bsc Package
  • tmatrix Package
  • shape Package
  • drag Package
  • dynamics Package
  • tools Package
  • utils Packages
  • ui Package
  • Errors and Warnings
• Conceptual Notes
  • Spherical wave representation
  • Scattering and the Rayleigh Hypothesis
  • Point-matching and angle projections
  • Beam truncation angle (for ott.BscPmGauss)
• Further Reading
• Documentation Terms of Use

Todo

Should all these sections stay here???

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/ott/checkouts/draft162/docs/Conceptual-Notes.rst, line 8.)

Todo

todo dynamics error

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/ott/checkouts/draft162/docs/Dynamics-Package.rst, line 32.)

Todo

Errors and warnings

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/ott/checkouts/draft162/docs/Errors.rst, line 11.)

Todo

A lot of this needs to be re-written and figures updated

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/ott/checkouts/draft162/docs/Example-Gui.rst, line 8.)

Todo

This isn’t done yet

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/ott/checkouts/draft162/docs/Example-Gui.rst, line 173.)

Todo

Update the how to cite text in the Launcher (and finish launcher)

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/ott/checkouts/draft162/docs/Getting-Started.rst, line 104.)

Todo

Add how to cite, and in README too

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/ott/checkouts/draft162/docs/Introduction.rst, line 74.)

Todo

Add how to cite, and in README too

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/ott/checkouts/draft162/docs/Introduction.rst, line 78.)

Todo

tools package

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/ott/checkouts/draft162/docs/Tools-Package.rst, line 14.)

Todo

Finish ui package docs

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/ott/checkouts/draft162/docs/Ui-Package.rst, line 12.)

Todo

utils packages docs

(The original entry is located in /home/docs/checkouts/readthedocs.org/user_builds/ott/checkouts/draft162/docs/Utils-Package.rst, line 13.)