This small instruction manuel, is an "all you need to know" to properly run DarkF. ***************** Your own directory *********************** First of all, if you want to create your own directory for DarkF simulation, you will need few things in it: - The darkf program (dependind on your OS). - The 3 parameter files ("paramsimu.in", "paramirrors.in" and "paramfiles.in"). - The Directory "LIB", contains the different libraries used by DarkF. - The directory "CARTES", contains the maps used by DarkF. - A directory named "RESULTS". - The "cygwin1.dll" file, (optional, only for Windows execution). => WARNING: You can't rename any of these items. ****************** Parameters files *********************** "paramfiles": contains the name of the other parameter files. "paramsimu.in": defines the simulation parameters (grid, resolution, the incoming beam, the ITF (Interferometer) part length,...). - For the grid size, it's better to use a minimum of 2 times the minimum mirror diameter. - For the resolution, it's better to take a power of 2 (generaly with a minimum of 128 due to the beam diffraction). You can also use a resolution of 1 (in x OR in y axis), if you simulate a "perfect" system (perfect mirrors=>without mirror map). - This is where you define the kind of simulation you want to do (Fabry-Perot, Double Cavity,...) NB: The OMC (Output Mode Cleaner) is only the projection of the dark fringe on a perfect TEM00, defined by the OMC lengths. "paramirrors.in": defines each mirror used in KAGRA. - You can precise here, if you want to use mirror maps (the default name is "nomap"=>perfect mirror). - The different mirror maps must be placed in the directory CARTES . To add new mirror maps, just place them in this directory. - The darkF mirror maps must have a specific structure: - 1st line: number of points in the x axis - 2nd line: number of points in the y axis - 3rd line: edge of the minimum value in x (in meter) - 4th line: edge of the maximum value in x (in meter) - 5th line: edge of the minimum value in y (in meter) - 6th line: edge of the maximum value in y (in meter) - then the mirror roughness information (in meter) BUT ON 1 ROW ****************** Running DarkF *************************** Unix: You just have to execute the command "./darkf". Mac: Open a Terminal (Appications->Utilities->Terminal) and execute "./darkF". Cygwin: Open a Terminal and execute the command "./darkF.exe". Windows XP: Open a Dos window (Start Menu->Execute->"cmd") and execute the command "darkF.exe" It will execute the simulation that you have defined in the "parasimu.in" and after running a first simulation, it invites you to continue or not, with the parameter variation of your choice. Just follow the instructions on the screen. At the end you will have to name your own results file (if you have chosen to make a parameter variation). If you want to quit, just enter a "false" value (if the choice is between 0 and 10, enter 11 or a negative value). PS: For Unix environment, if you want to run a long simulation, without waiting the end of it. Enter the command "nohup ./darkf***", then once you have made your choice for the simulation, press Ctrl+Z. Enter "bg" (to switch the program in background) and you can now, logout or shutdown the window and the simulation will run until it finishes by itself. ****************** Results ******************************** Once you have finished your simulation, a "results.out" file is created in the "RESULTS" directory, that sums up the parameters of your simulation, the mirrors parameters and the results of the system simulated. You can also find the different fields of the system, that can be plot, for example with matlab (see code matlab "visu.m" in the "RESULTS" directory). In the "RESULTS" directory, you will find your own results file (if you have chosen to make a parameter variation). ****************** Exporting the code ********************* If you want to use DarkF on an other enviroment (Unix, Mac, Windows), you have to copy the following directories and files: - "LIB" - "CARTES" - "darkf": the main program, depending of your OS. - The 3 parameter files ("paramsimu.in", "paramirrors.in" and "paramfiles.in"). - Don't forget to create a directory named "RESULTS". - The "cygwin1.dll" file (optional, for Windows only). And put all these items in the same directory. => WARNING: You can't remane any of these items. ****************** End ************************************ This version of DarkF has been created to be used with the free compiler g95 and the library FFTW. Copyright CNRS, Observatoire de la Côte d'Azur, ARTEMIS, Mikhael Pichot, Jean-Yves Vinet