diff --git a/README.md b/README.md index b9e2b14..0037362 100644 --- a/README.md +++ b/README.md @@ -4,8 +4,15 @@ Interferometer for Finesse 3. Can be used with the [finesse-virgo](https://gitlab.com/ifosim/finesse/finesse-virgo) package. -Katscript files are organized by priority number (first two number), -which indicate the file loading order, the lowest at first. +## Get started + +For simple use, `layout` file can be used. A layout is a list of files +separated by new line to load in order to create a +[finesse3](https://finesse.ifosim.org) model. The "simple" model +present some quick model with little components which allows to +manipulate easily a finesse model. +The "finesse-virgo" model correspond to the model available in the +[finesse-virgo package](https://git.ligo.org/ifosim/finesse-virgo). ## Sections @@ -13,87 +20,45 @@ Katscript files are organized in different types, which are `values`, `optical setup`, `link`, `cavities definition`, `degree of freedom`, `detectors` and `after variables`. -### values +### variables -priority number from 00 to 09 +Contains values used in the setup. -Contains values used in the setup +It can defines variable which depends of components in the setup for +preprocessing (finesse-virgo package for example) too. -### optical setup +### components -priority number from 10 to 19 +Defined part of the optical setup (Laser, Mirror, etc.) or set of parts. -Defined part of the optical setup (Laser, Mirror, etc.) - -### link - -priority number from 20 to 49 +### links Link together parts of the optical setup defined before ### cavities -priority number from 50 to 69 - -Defines Finesse 3 cavity +Defines Finesse3 cavity ### degree of freedom -priority number from 70 to 89 - -Defines Finesse 3 degree of freedom +Defines Finesse3 degree of freedom ### detectors -priority number from 70 to 89 - -Add Finesse 3 readout - -### after variables - -priority number from 90 to 99 - -Defines variable which depends of components in the setup for -preprocessing (finesse-virgo package for example) +Add Finesse3 detectors ## Getting started Code example to build a Virgo model with these scripts. ```py + from pathlib import Path + + layout_file = Path("layout/finesse-virgo/no_benches") # path to layout file + with layout_file.open() as f: + files = f.read().splitlines() # convert layout file to list of path virgo = Virgo( - files_to_parse = [ - "00_variables.kat", - "01_arm_north.kat", - "01_arm_west.kat", - "01_detection.kat", - "01_laser_and_modulator.kat", - "01_recycling_cavity.kat", - "02_B5_path.kat", - "05_attenuator.kat", - "05_link_length.kat", - "05_modulation.kat", - "05_tuning.kat", - "10_laser_and_modulator.kat", - "10_faraday_isolator.kat", - "10_recycling_cavity.kat", - "10_arm_north.kat", - "10_arm_west.kat", - "10_detection.kat", - "10_B2_attenuator.kat", - "10_B4_attenuator.kat", - "25_link_laser_and_modulator_faraday_isolator_noSIB1.kat", - "20_link_faraday_isolator_recycling_cavity.kat", - "25_link_faraday_isolator_B2_attenuator_noSIB2.kat", - "20_link_recycling_cavity_arms.kat", - "25_link_recycling_cavity_detection_noSDB1.kat", - "25_link_recycling_cavity_B4_attenuator_noSPRB.kat", - "30_link_arm_north_SNEB.kat", - "50_cavities.kat", - "70_detectors.kat", - "70_degree_of_freedom.kat", - "99_after_variables.kat", - ], + files_to_parse = files, # create model with the given list of path ) ``` diff --git a/two_FP b/two_FP deleted file mode 100644 index 75acdc4..0000000 --- a/two_FP +++ /dev/null @@ -1,14 +0,0 @@ -variables/main.kat -variables/simple/main.kat -variables/simple/cavities.kat -components/simple/laser.kat -components/simple/beamsplitter.kat -components/simple/cavity_west.kat -components/simple/cavity_north.kat -components/simple/detection.kat -links/simple/laser_beamsplitter.kat -links/simple/beamsplitter_cavity_west.kat -links/simple/beamsplitter_cavity_north.kat -detectors/simple/cavity_west.kat -detectors/simple/cavity_north.kat -degree_of_freedom/simple/main.kat