Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nchimitt committed Jul 29, 2021
1 parent 84b04e3 commit 5d9d2a1
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ 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 the full version of the simulator described in our work. The v1_sim_example1 is a documented typical usage case.
- There are two example files provided, the "Example_1_full.py" file, and the "Example_2_tiltonly.py" files. The tilt-only file is simpler, yet the Example_1_full offers the full version of the simulator described in our work. The Example_1_full 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 "TurbSim_v1_main.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

Expand Down

0 comments on commit 5d9d2a1

Please sign in to comment.