From d0e824edd91748be08f4c234c04eadc2ae14c88e Mon Sep 17 00:00:00 2001 From: linarphy Date: Thu, 7 Nov 2024 15:36:06 +0100 Subject: [PATCH] Fix README --- README.md | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 0037362..c88d724 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,35 @@ Interferometer for Finesse 3. Can be used with the [finesse-virgo](https://gitlab.com/ifosim/finesse/finesse-virgo) package. -## Get started +## Getting 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 +separated by new lines 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). +### 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 Katscript files are organized in different types, which are `values`, @@ -46,22 +65,3 @@ Defines Finesse3 degree of freedom ### 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.