From 80c00f25b8588e4207aa0806e4def4b5a1608c8e Mon Sep 17 00:00:00 2001 From: "Chimitt, Nicholas M" Date: Tue, 6 Jul 2021 22:00:41 -0400 Subject: [PATCH] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 1ac852d..6b799c2 100644 --- a/README.md +++ b/README.md @@ -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.