yao(1) [debian man page]
YAO(1) General Commands Manual YAO(1) NAME
yao - Adaptive Optics simulation tool in yorick SYNOPSIS
Start yao with the gtk GUI: yao parfile.par yorick -i yaopy.i parfile.par Within yorick (no GUI, but same graphical output) #include yao.i aoread,"parfile.par"; aoinit; aoloop; go; DESCRIPTION
Yao is a monte-carlo simulation package for adaptive optics. It includes fast core coded in C (e.g. wavefront sensing) that are glued together by yorick interpreted code. One defines the system to evaluate using a configuration file, and then run aoread, aoinit and aoloop. Yao features: * Shack-Hartmann and Curvature WFS, on or off axis. * Stackarray (piezostack), curvature (bimorph), modal (zernike) and Tip-Tilt deformable mirrors are supported. The altitude of conjugation is adjustable. * An arbitrary number of WFSs and DMs can be selected, with the possibility of mixing types. It is therefore possible (and easy) to simu- late single DM systems, as well as single non-zero conjugate, GLAO and MCAO systems. * It supports Natural and Laser Guide Stars (or a mix), WFS with photon and read-out noise. * It uses a multi-layered atmospheric model, with geometrical propagation only. * The loop execution has been optimized for speed: the critical routines have been coded in C. Yorick is thus used as a convenient glue between lower levels optimized C calls. Overall, this is rather efficient: A simple 6x6 Shack-Hartmann system runs at up to 650 itera- tions per second on an apple dual 2GHz G5 (200 iterations/sec for a full diffraction propagation model). A 50x50 Shack-Hartmann system runs at about 3 iterations/s. A 188 curvature system runs at 25 iterations/s. * Straightforward scriptability to probe parameter domains. * GTK GUI to change some of the system parameters while the loop is running (new in v4.0). This provides an educational approach to Adap- tive Optics (newbies can play with the parameters and immediately sees how the system reacts) and can also provides a quick way to investigate the stability conditions for a newly designed system, before entering more serious Monte-carlo simulations. Options help,aoread will give you information about the syntax, parameters and keywords of aoread. See help,aoinit and help,aoloop also. AUTHOR
Francois Rigaut, Gemini Observatory FILES
Input files: parfile.par A yao parameter file. This file follows a regular yorick syntax. It is directly included by yorick to define the structures used by yao. As it might be a little bit daunting to create a parfile from scratch, example parfiles are provided. Their location depends on the installation. Search for yao/examples (e.g. shx6x.par, curvature.par) screen*.fits To simulate the atmospheric turbulence, yao needs phase screens. You can create phase screens with create_phase_screens(). They might also be included in your distribution. Output files: parfile.res After a simulation run, results are output in parfile.res in the cwd BUGS
Lots. LGS uplink propagation is not implemented Shack-Hartmann cross talk between subapertures is not implemented Many more. SEE ALSO
yorick(1) 4th Berkeley Distribution 2007 December 12 YAO(1)
Check Out this Related Man Page
PARL(1) User Contributed Perl Documentation PARL(1) NAME
parl - Binary PAR Loader SYNOPSIS
(Please see pp for convenient ways to make self-contained executables, scripts or PAR archives from perl programs.) To make a PAR distribution from a CPAN module distribution: % parl -p # make a PAR dist under the current path % parl -p Foo-0.01 # assume unpacked CPAN dist in Foo-0.01/ To manipulate a PAR distribution: % parl -i Foo-0.01-i386-freebsd-5.8.0.par # install % parl -i http://foo.com/Foo-0.01 # auto-appends archname + perlver % parl -i cpan://AUTRIJUS/PAR-0.74 # uses CPAN author directory % parl -u Foo-0.01-i386-freebsd-5.8.0.par # uninstall % parl -s Foo-0.01-i386-freebsd-5.8.0.par # sign % parl -v Foo-0.01-i386-freebsd-5.8.0.par # verify To use Hello.pm from ./foo.par: % parl -A./foo.par -MHello % parl -A./foo -MHello # the .par part is optional Same thing, but search foo.par in the @INC; % parl -Ifoo.par -MHello % parl -Ifoo -MHello # ditto Run test.pl or script/test.pl from foo.par: % parl foo.par test.pl # looks for 'main.pl' by default, # otherwise run 'test.pl' To make a self-containing executable containing a PAR file : % parl -O./foo foo.par % ./foo test.pl # same as above To embed the necessary non-core modules and shared objects for PAR's execution (like "Zlib", "IO", "Cwd", etc), use the -b flag: % parl -b -O./foo foo.par % ./foo test.pl # runs anywhere with core modules installed If you also wish to embed core modules along, use the -B flag instead: % parl -B -O./foo foo.par % ./foo test.pl # runs anywhere with the perl interpreter This is particularly useful when making stand-alone binary executables; see pp for details. DESCRIPTION
This stand-alone command offers roughly the same feature as "perl -MPAR", except that it takes the pre-loaded .par files via "-Afoo.par" instead of "-MPAR=foo.par". Additionally, it lets you convert a CPAN distribution to a PAR distribution, as well as manipulate such distributions. For more information about PAR distributions, see PAR::Dist. You can use it to run .par files: # runs script/run.pl in archive, uses its lib/* as libraries % parl myapp.par run.pl # runs run.pl or script/run.pl in myapp.par % parl otherapp.pl # also runs normal perl scripts However, if the .par archive contains either main.pl or script/main.pl, it is used instead: % parl myapp.par run.pl # runs main.pl, with 'run.pl' as @ARGV Finally, the "-O" option makes a stand-alone binary executable from a PAR file: % parl -B -Omyapp myapp.par % ./myapp # run it anywhere without perl binaries With the "--par-options" flag, generated binaries can act as "parl" to pack new binaries: % ./myapp --par-options -Omyap2 myapp.par # identical to ./myapp % ./myapp --par-options -Omyap3 myap3.par # now with different PAR For an explanation of stand-alone executable format, please see par.pl. SEE ALSO
PAR, PAR::Dist, par.pl, pp AUTHORS
Audrey Tang <cpan@audreyt.org> <http://par.perl.org/> is the official PAR website. You can write to the mailing list at <par@perl.org>, or send an empty mail to <par-subscribe@perl.org> to participate in the discussion. Please submit bug reports to <bug-par@rt.cpan.org>. COPYRIGHT
Copyright 2002-2009 by Audrey Tang <cpan@audreyt.org>. Neither this program nor the associated pp program impose any licensing restrictions on files generated by their execution, in accordance with the 8th article of the Artistic License: "Aggregation of this Package with a commercial distribution is always permitted provided that the use of this Package is embedded; that is, when no overt attempt is made to make this Package's interfaces visible to the end user of the commercial distribution. Such use shall not be construed as a distribution of this Package." Therefore, you are absolutely free to place any license on the resulting executable, as long as the packed 3rd-party libraries are also available under the Artistic License. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See <http://www.perl.com/perl/misc/Artistic.html> perl v5.18.2 2012-01-06 PARL(1)