From b1ae632521b17730a56ad09dbe1d96a6689646ed Mon Sep 17 00:00:00 2001 From: Eugeniy Mikhailov Date: Tue, 16 Dec 2014 14:01:16 -0500 Subject: replaced t2t version of README with markdown one --- README.md | 78 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ README.t2t | 68 ------------------------------------------------------ 2 files changed, 78 insertions(+), 68 deletions(-) create mode 100644 README.md delete mode 100644 README.t2t diff --git a/README.md b/README.md new file mode 100644 index 0000000..52e43e2 --- /dev/null +++ b/README.md @@ -0,0 +1,78 @@ +% Gaussian beam propagation package. +% Eugeniy Mikhailov +% 2013 + +# Main features + +Can treat lenses and empty spaces (with a given refraction index). And +able to calculate Gaussian beam propagation via ABCD matrix formalism. + +## Gaussian beam travel visualization + +Given starting Gaussian mode parameter (q) calculates q in the given +point(s) along optical path. There is + +It can propagate Gaussian beam back and force and compare the beam +profiles after such propagation. + +For a quick demo run: + + solution_visualization_demo.m + +## Mode matching + +Automatically search for a way to mode match a given Gaussian beam to +desired one at given distance via set of lenses in between. Very handy +for injection of a known beam to a single mode fiber or a cavity. + +It might take a while to compute but for a quick demo run: + + mode_match_demo.m + +## Cavity design + +- calculates if resonator is stable +- calculates and plots resonant mode profile + +For demo run: + + cavity_design_demo.m + +# Brief history of the project + +The original code dates as old as 2004 (at least I find some files that +old), but logged changes started only in 2006. Initially development is +done by Eugeniy Mikhailov with first files dated by Jun 2006, but it was +started even earlier. In 2012-2013 Matt Argao extended code to +automatically find mode matching solution from given set of optical +elements. + +## Version 4.1.1 + +Small typos fixes. Added real life mode matching example of the fiber +mode to the gyro cavity mode. + +## Version 4.1 + +Cavity design polish up and bug fixes. + +## Version 4.0 + +Cavity design module + +## Version 3.1 + +Demos are added/modified + +## Version 3.0 + +Addition of the automatic mode matcher + +## Versions 2.0 + +Visual mode matcher check and beam propagation visualization + +## Version 1.0 and earlier + +Initial ABCD formalism and unrecorded modifications. + diff --git a/README.t2t b/README.t2t deleted file mode 100644 index 56bb1a6..0000000 --- a/README.t2t +++ /dev/null @@ -1,68 +0,0 @@ -Gaussian beam propagation package. -Eugeniy Mikhailov -2013 - - -= Main features = - -Can treat lenses and empty spaces (with a given refraction index). And able -to calculate Gaussian beam propagation via ABCD matrix formalism. - -== Gaussian beam travel visualization == - -Given starting Gaussian mode parameter (q) calculates q in the given point(s) -along optical path. There is - -It can propagate Gaussian beam back and force and compare the beam -profiles after such propagation. - -For a quick demo run: -``` solution_visualization_demo.m - -== Mode matching == - -Automatically search for a way to mode match a given Gaussian beam to -desired one at given distance via set of lenses in between. Very handy for -injection of a known beam to a single mode fiber or a cavity. - -It might take a while to compute but for a quick demo run: -``` mode_match_demo.m - -== Cavity design == -- calculates if resonator is stable -- calculates and plots resonant mode profile - -For demo run: -``` cavity_design_demo.m - -= Brief history of the project = - -The original code dates as old as 2004 (at least I find some files that -old), but logged changes started only in 2006. Initially development is -done by Eugeniy Mikhailov with first files dated by Jun 2006, but it -was started even earlier. In 2012-2013 Matt Argao extended code to -automatically find mode matching solution from given set of optical -elements. - -== Version 4.1.1 == -Small typos fixes. -Added real life mode matching example of the fiber mode to the gyro cavity mode. - -== Version 4.1 == -Cavity design polish up and bug fixes. - -== Version 4.0 == -Cavity design module - -== Version 3.1 == -Demos are added/modified - -== Version 3.0 == -Addition of the automatic mode matcher - -== Versions 2.0 == -Visual mode matcher check and beam propagation visualization - -== Version 1.0 and earlier == -Initial ABCD formalism and unrecorded modifications. - -- cgit v1.2.3