Fix README & misspelled name
This commit is contained in:
parent
bff3da75d7
commit
9b6fbedf55
GPG key ID:
434A18DA831BC610
2 changed files with 25 additions and 74 deletions
85
README.md
85
README.md
|
|
@ -4,8 +4,15 @@ Interferometer for Finesse 3. Can be used with the
|
||||||
[finesse-virgo](https://gitlab.com/ifosim/finesse/finesse-virgo)
|
[finesse-virgo](https://gitlab.com/ifosim/finesse/finesse-virgo)
|
||||||
package.
|
package.
|
||||||
|
|
||||||
Katscript files are organized by priority number (first two number),
|
## Get started
|
||||||
which indicate the file loading order, the lowest at first.
|
|
||||||
|
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
|
## Sections
|
||||||
|
|
||||||
|
|
@ -13,87 +20,45 @@ Katscript files are organized in different types, which are `values`,
|
||||||
`optical setup`, `link`, `cavities definition`, `degree of freedom`,
|
`optical setup`, `link`, `cavities definition`, `degree of freedom`,
|
||||||
`detectors` and `after variables`.
|
`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.)
|
### links
|
||||||
|
|
||||||
### link
|
|
||||||
|
|
||||||
priority number from 20 to 49
|
|
||||||
|
|
||||||
Link together parts of the optical setup defined before
|
Link together parts of the optical setup defined before
|
||||||
|
|
||||||
### cavities
|
### cavities
|
||||||
|
|
||||||
priority number from 50 to 69
|
Defines Finesse3 cavity
|
||||||
|
|
||||||
Defines Finesse 3 cavity
|
|
||||||
|
|
||||||
### degree of freedom
|
### degree of freedom
|
||||||
|
|
||||||
priority number from 70 to 89
|
Defines Finesse3 degree of freedom
|
||||||
|
|
||||||
Defines Finesse 3 degree of freedom
|
|
||||||
|
|
||||||
### detectors
|
### detectors
|
||||||
|
|
||||||
priority number from 70 to 89
|
Add Finesse3 detectors
|
||||||
|
|
||||||
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)
|
|
||||||
|
|
||||||
## Getting started
|
## Getting started
|
||||||
|
|
||||||
Code example to build a Virgo model with these scripts.
|
Code example to build a Virgo model with these scripts.
|
||||||
|
|
||||||
```py
|
```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(
|
virgo = Virgo(
|
||||||
files_to_parse = [
|
files_to_parse = files, # create model with the given list of path
|
||||||
"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",
|
|
||||||
],
|
|
||||||
)
|
)
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
|
||||||
14
two_FP
14
two_FP
|
|
@ -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
|
|
||||||
Loading…
Reference in a new issue