-------------------------------------------- INSTALLATION PROCESS (& BRIEF INTRODUCTION): -------------------------------------------- (A few minutes only are necessary for reading and installing!) 00-Subscribe to the Software Package CAOS mailing-list ! Either by pointing your browser to https://sympa-n.oca.eu/wws/info/caos and following the instructions therein, or by sending a message to sympanice@oca.eu with no subject and the following instruction in the body of the message: subscribe caos my.email@address [Subscribing to this mailing-list will insure you to receive new versions/patches/updates related to the Software Package CAOS and the CAOS Problem-Solving Environment (PSE).] 01-First install the structure of the CAOS PSE (from http://lagrange.oca.eu/caos/caos_pse7.0/). 02-Change directory to .../caos_pse/packages/, then click on the link "Soft.Pack.CAOS 7.0 archive file" and unpack the downloaded file CAOS_Software_Package_7.0.tgz (with, e.g., "tar xvfz"). A directory called "CAOS_Software_Package_7.0" will then be created. Note that you will need to eliminate the .tar file when unpacking is concluded - in fact NO OTHER FILES than the set of modules (packages) have to be present in the "packages" directory. 03-Please note that some modules of this distribution also need the IDL Astronomy User's Library, commonly called "astrolib". This library is available from http://idlastro.gsfc.nasa.gov. 04-Change directory to .../work_caos/, then click on the link "Example projects using the Soft.Pack.CAOS 7.0" and unpack the downloaded file Projects.tgz, containing the directory "Projects" where some example projects can be found. 05-UNIX/LINUX/MACOSX cases: Type "source caos_env.csh" (or .sh). [Note that this is to be done for each opened shell where you will use IDL together with CAOS. Alternatively you can move the content of the file caos_env.csh into your .cshrc or .bashrc and .profile files. See the "trick" (point 04 of the "Final Remarks") given at the end of this file to avoid this step and step 09 here below.] 06-Launch IDL [See the "trick" (point 04 of the "Final Remarks") given at the end of this file to avoid this step and step 08 here above in the UNIX/LINUX/MACOSX cases.] 07-Type "worksheet" at the CAOS prompt in order to use the CAOS Application Builder. 08-Type "@compile_all_CAOS_modules" in order to re-generate the default parameter files of the whole set of modules (upgrading so any possible pre-defined path). 09-You can find some examples in work_caos/Projects to play around with. Let open one example project from the worksheet ("File"->"Open Project"). NB: steps 00,01,02,03,04,08 are necessary just once: during installation. ------------------- SOME FINAL REMARKS: ------------------- 00-Refer to the template module xxx for a guide for writing a new module and so include your IDL code within the CAOS PSE (and submit it to us for inclusion in future distributions). 01-Refer to http://lagrange.oca.eu/caos for further informations on the CAOS Problem-Solving Environment and its packages (or for submission of bug fixes, new modules, etc.). 02-Please never redistribute any CAOS part by yourself, rather refer to http://lagrange.oca.eu/caos -- or at least recommend subscription to the mailing-list. 03-A paper about the first version of the Soft.Pack.CAOS was published in 2005: Marcel Carbillet, Christophe Vérinaud, Bruno Femenia, Armando Riccardi and Luca Fini, "Modelling Astronomical Adaptive Optics - I. The Software Package CAOS", MNRAS 356 (4), 1263--1275 (2005). An upgrade presenting the present version (7.0) will be presented at the SPIE "Astronomical Telescopes & Instrumentation" conference to be held in Edinburgh, 30 june 2016 (paper n. 9909-319). 04-UNIX/LINUX/MACOSX cases: If you will use different Software Packages but would like to have the simulation projects made with different installed packages in different locations (not all the simulation projects in the same "work_caos/Projects" directory), there is a solution which still permits to use modules from the various Software Packages together anyway. A-Make one working directory per Software Package (e.g. work_caos and work_airy) B-Add one alias for each installed Software Package in your .cshrc or .bashrc (and .profile) file, for example for the Software Package CAOS: alias caos='cd YOUR_PATH/work_caos ; source caos_env.sh ; idl' and for the Software Package AIRY: alias airy='cd YOUR_PATH/work_airy ; source caos_env.sh ; idl' C-Then simply type "caos" (or "airy") to launch IDL+the CAOS PSE+move in the CAOS (or AIRY) working directory, all together. 05-New projects start within the worksheet with "File"->"New Project". Modules are put within the worksheet through button "Modules", and can be cloned or deleted using "Edit"->"Clone module" or "Edit"->"Delete item". Each color at the left- or right-side of a module represents a type of input or output. In order to link two modules, click on the output of the first one and then click on the input of the second one. When the design of your simulation is completed, including setting of the total number of iterations, save the project using "File"->"Save Project". Then you can set the parameters related to each module using its dedicated GUI called by clicking on the module at any moment. 06-For a detailed tutorial refer to: http://lagrange.oca.eu/caos/tutorial/tutorial.html 07-In order to run a project, for example "Propagation": > .rn ./Projects/Propagation/project.pro or alternatively use button "Run" from the CAOS PSE worksheet. 08-In order to be able to use the FFTWND C-written routine in alternative to the standard IDL FFT routine, please follow the instructions within the file "FFTWNDPackage_Installation.txt", downloaded by clicking on "FFTWND package - installation instructions". --------------------------------------- Completed June 2016 - Marcel Carbillet