Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nchimitt authored Jul 7, 2021
1 parent b4f43ac commit 80c00f2
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,13 @@ Nicholas Chimitt and Stanley H. Chan "Simulating anisoplanatic turbulence by sam

How to use:

There are two example files provided, the "TiltOnly.py" file, and the "v1_sim_example1.py" files. The tilt-only file is simpler, yet the v1_sim_example1 offers that described in our work. The v1_sim_example1 is a documented typical usage case.
- There are two example files provided, the "TiltOnly.py" file, and the "v1_sim_example1.py" files. The tilt-only file is simpler, yet the v1_sim_example1 offers that described in our work. The v1_sim_example1 is a documented typical usage case.

The "utilities.py" file forms the main body of the functionality, calling upon "motion_compensate.py" and "integrals_spatial_corr.py" as needed. The functions therein are documented to help in their interpretability.
- The "utilities.py" file forms the main body of the functionality, calling upon "motion_compensate.py" and "integrals_spatial_corr.py" as needed. The functions therein are documented to help in their interpretability.

Packages included

We use a function to simplify some indexing "nollToZernInd" (Tim van Werkhoven, Jason Saredy; https://github.com/tvwerkhoven/libtim-py/blob/master/libtim/zern.py)
- We use a function to simplify some indexing "nollToZernInd" (Tim van Werkhoven, Jason Saredy; https://github.com/tvwerkhoven/libtim-py/blob/master/libtim/zern.py)

We would also point those interested in this file to use this version, which offers more flexibility and ease of use than its MATLAB counterpart.

Expand Down

0 comments on commit 80c00f2

Please sign in to comment.