linarphy/finesse-virgo-model
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fix README

Browse source
This commit is contained in:
linarphy 2024-11-07 15:36:06 +01:00
parent 9b6fbedf55
commit d0e824edd9
Signed by: linarphy
GPG key ID: 434A18DA831BC610
1 changed files with 21 additions and 21 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

42
README.md
View file

@ -4,16 +4,35 @@ 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.
## Get started ## Getting started
For simple use, `layout` file can be used. A layout is a list of files 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 separated by new lines to load in order to create a
[finesse3](https://finesse.ifosim.org) model. The "simple" model [finesse3](https://finesse.ifosim.org) model. The "simple" model
present some quick model with little components which allows to present some quick model with little components which allows to
manipulate easily a finesse model. manipulate easily a finesse model.
The "finesse-virgo" model correspond to the model available in the The "finesse-virgo" model correspond to the model available in the
[finesse-virgo package](https://git.ligo.org/ifosim/finesse-virgo). [finesse-virgo package](https://git.ligo.org/ifosim/finesse-virgo).
### Example
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 = files, # create model with the given list of path
)
```
The advantage of this is the control we have over the interferometer
simulation, and the readibility. Tracking change is also easier,
variable definition being detached from setup configuration.
## Sections ## Sections
Katscript files are organized in different types, which are `values`, Katscript files are organized in different types, which are `values`,
@ -46,22 +65,3 @@ Defines Finesse3 degree of freedom
### detectors ### detectors
Add Finesse3 detectors 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 = files, # create model with the given list of path
)
```
The advantage of this is the control we have over the interferometer
simulation, and the readibility. Tracking change is also easier,
variable definition being detached from setup configuration.