{"id":47,"date":"2017-11-12T15:23:49","date_gmt":"2017-11-12T14:23:49","guid":{"rendered":"https:\/\/sites-lira.obspm.fr\/psls\/?page_id=47"},"modified":"2025-01-22T14:39:29","modified_gmt":"2025-01-22T13:39:29","slug":"documentation","status":"publish","type":"page","link":"https:\/\/sites-lira.obspm.fr\/psls\/documentation\/","title":{"rendered":"Documentation"},"content":{"rendered":"<p>The generation of a given simulation requires the edition of a <a href=\"https:\/\/sites-lira.obspm.fr\/psls\/configuration-file\/\"><strong>configuration file<\/strong><\/a> in YAML format. The parameters involved in the configuration file are explained <a href=\"https:\/\/sites-lira.obspm.fr\/psls\/configuration-file\/\">here<\/a> . An example named <em>psms.yaml<\/em> is also provided in the package.<\/p>\n<p>To execute PSLS, type:<\/p>\n<pre> psls.py -P -V psls.yaml<\/pre>\n<p>The option <em>-V<\/em> makes the program verbose while the option <em>-P<\/em> generates some plots (the option <em>&#8211; -extended-plots<\/em>\u00a0 generates additional plots).<\/p>\n<p>As output, the program generates the simulated light-curve in an ASCII file named <em><strong>&lt;ID&gt;<\/strong><\/em>.dat, where\u00a0 <em>ID<\/em> is the star ID (an arbitrary number defined in the configuration file).<\/p>\n<p>By default a single light-curve obtained by averaging over all the cameras is generated. However, with the option <code><em><strong>-m<\/strong><\/em><\/code>, the program\u00a0 averages the\u00a0 light-curves from the same group of camera and merges (interlace)\u00a0 them together,\u00a0 while with the option\u00a0<code><em><strong>-f<\/strong><\/em><\/code> the program returns the individual\u00a0 light-curves merged (interlaced) together.<\/p>\n<p>Below are all available options:<\/p>\n<ul>\n<li>-v : print program version<\/li>\n<li>-P : do some plots<\/li>\n<li>&#8211;pdf : the plots are saved as PDF otherwise as PNG (default)<\/li>\n<li>-V : verbose mode<\/li>\n<li>-f : save the LC associated with each individual camera, otherwise average over all the cameras (this is the default choice)<\/li>\n<li>-m : save the merged LC: LC from the same group of camera are averaged and then averaged LC are merged(\/interlaced)<\/li>\n<li>-o &lt;path&gt; : output directory (the working directory is by default assumed)<\/li>\n<li>-M &lt;number&gt; : number of Monte-Carlo simulations performed (not yet operational)<\/li>\n<li>&#8211;extended-plots : an extended set of plots are displayed (activates automatically the -P option)<\/li>\n<li>&#8211;psd: save the PSD associated with the averaged light-curve (averaged over all cameras)<\/li>\n<li>&#8211;hdf5: save in a HDF5 file the mean light-curve (LC) and the various simulation components and data<\/li>\n<li>&#8211;proto-sas: the data are saved in a HDF5 file and in format compatible with the prototype SAS pipeline<\/li>\n<\/ul>\n<p>For more information about the simulator, see the following documents:<\/p>\n<ul>\n<li>A paper: <strong>\u00ab\u00a0<\/strong><a href=\"https:\/\/www.aanda.org\/articles\/aa\/pdf\/2019\/04\/aa34822-18.pdf\">The PLATO Solar-like Light-curve Simulator (PSLS): A tool to generate realistic stellar light-curves with instrumental effects representative of the PLATO mission<\/a>\u00ab\u00a0, Samadi et al, 2019, A&amp;A, 624, A117,\u00a0 <strong>if you use PSLS please cite this pape<\/strong>r;<\/li>\n<li><a href=\"https:\/\/sites-lira.obspm.fr\/psls\/files\/2020\/06\/PSLS.pdf\">This presentation<\/a><\/li>\n<\/ul>\n\n\n<p class=\"wp-block-paragraph\"><\/p>\n","protected":false},"excerpt":{"rendered":"<p>The generation of a given simulation requires the edition of a configuration file in YAML format. The parameters involved in the configuration file are explained here . An example named psms.yaml is also provided in the package. To execute PSLS, type: psls.py -P -V psls.yaml The option -V makes the program verbose while the option [&hellip;]<\/p>\n","protected":false},"author":47,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-47","page","type-page","status-publish","hentry"],"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v28.4 - https:\/\/yoast.com\/product\/yoast-seo-wordpress\/ -->\n<title>Documentation - the PLATO Solar-like Light-curve Simulator (PSLS)<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/sites-lira.obspm.fr\/psls\/documentation\/\" \/>\n<meta property=\"og:locale\" content=\"fr_FR\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Documentation - the PLATO Solar-like Light-curve Simulator (PSLS)\" \/>\n<meta property=\"og:description\" content=\"The generation of a given simulation requires the edition of a configuration file in YAML format. The parameters involved in the configuration file are explained here . An example named psms.yaml is also provided in the package. To execute PSLS, type: psls.py -P -V psls.yaml The option -V makes the program verbose while the option [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/sites-lira.obspm.fr\/psls\/documentation\/\" \/>\n<meta property=\"og:site_name\" content=\"the PLATO Solar-like Light-curve Simulator (PSLS)\" \/>\n<meta property=\"article:modified_time\" content=\"2025-01-22T13:39:29+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Dur\u00e9e de lecture estim\u00e9e\" \/>\n\t<meta name=\"twitter:data1\" content=\"2 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/sites-lira.obspm.fr\\\/psls\\\/documentation\\\/\",\"url\":\"https:\\\/\\\/sites-lira.obspm.fr\\\/psls\\\/documentation\\\/\",\"name\":\"Documentation - the PLATO Solar-like Light-curve Simulator (PSLS)\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/sites-lira.obspm.fr\\\/psls\\\/#website\"},\"datePublished\":\"2017-11-12T14:23:49+00:00\",\"dateModified\":\"2025-01-22T13:39:29+00:00\",\"breadcrumb\":{\"@id\":\"https:\\\/\\\/sites-lira.obspm.fr\\\/psls\\\/documentation\\\/#breadcrumb\"},\"inLanguage\":\"fr-FR\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/sites-lira.obspm.fr\\\/psls\\\/documentation\\\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\\\/\\\/sites-lira.obspm.fr\\\/psls\\\/documentation\\\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Accueil\",\"item\":\"https:\\\/\\\/sites-lira.obspm.fr\\\/psls\\\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Documentation\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/sites-lira.obspm.fr\\\/psls\\\/#website\",\"url\":\"https:\\\/\\\/sites-lira.obspm.fr\\\/psls\\\/\",\"name\":\"the PLATO Solar-like Light-curve Simulator (PSLS)\",\"description\":\"\",\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/sites-lira.obspm.fr\\\/psls\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"fr-FR\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Documentation - the PLATO Solar-like Light-curve Simulator (PSLS)","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/sites-lira.obspm.fr\/psls\/documentation\/","og_locale":"fr_FR","og_type":"article","og_title":"Documentation - the PLATO Solar-like Light-curve Simulator (PSLS)","og_description":"The generation of a given simulation requires the edition of a configuration file in YAML format. The parameters involved in the configuration file are explained here . An example named psms.yaml is also provided in the package. To execute PSLS, type: psls.py -P -V psls.yaml The option -V makes the program verbose while the option [&hellip;]","og_url":"https:\/\/sites-lira.obspm.fr\/psls\/documentation\/","og_site_name":"the PLATO Solar-like Light-curve Simulator (PSLS)","article_modified_time":"2025-01-22T13:39:29+00:00","twitter_card":"summary_large_image","twitter_misc":{"Dur\u00e9e de lecture estim\u00e9e":"2 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/sites-lira.obspm.fr\/psls\/documentation\/","url":"https:\/\/sites-lira.obspm.fr\/psls\/documentation\/","name":"Documentation - the PLATO Solar-like Light-curve Simulator (PSLS)","isPartOf":{"@id":"https:\/\/sites-lira.obspm.fr\/psls\/#website"},"datePublished":"2017-11-12T14:23:49+00:00","dateModified":"2025-01-22T13:39:29+00:00","breadcrumb":{"@id":"https:\/\/sites-lira.obspm.fr\/psls\/documentation\/#breadcrumb"},"inLanguage":"fr-FR","potentialAction":[{"@type":"ReadAction","target":["https:\/\/sites-lira.obspm.fr\/psls\/documentation\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/sites-lira.obspm.fr\/psls\/documentation\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Accueil","item":"https:\/\/sites-lira.obspm.fr\/psls\/"},{"@type":"ListItem","position":2,"name":"Documentation"}]},{"@type":"WebSite","@id":"https:\/\/sites-lira.obspm.fr\/psls\/#website","url":"https:\/\/sites-lira.obspm.fr\/psls\/","name":"the PLATO Solar-like Light-curve Simulator (PSLS)","description":"","potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/sites-lira.obspm.fr\/psls\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"fr-FR"}]}},"_links":{"self":[{"href":"https:\/\/sites-lira.obspm.fr\/psls\/wp-json\/wp\/v2\/pages\/47","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/sites-lira.obspm.fr\/psls\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/sites-lira.obspm.fr\/psls\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/sites-lira.obspm.fr\/psls\/wp-json\/wp\/v2\/users\/47"}],"replies":[{"embeddable":true,"href":"https:\/\/sites-lira.obspm.fr\/psls\/wp-json\/wp\/v2\/comments?post=47"}],"version-history":[{"count":55,"href":"https:\/\/sites-lira.obspm.fr\/psls\/wp-json\/wp\/v2\/pages\/47\/revisions"}],"predecessor-version":[{"id":442,"href":"https:\/\/sites-lira.obspm.fr\/psls\/wp-json\/wp\/v2\/pages\/47\/revisions\/442"}],"wp:attachment":[{"href":"https:\/\/sites-lira.obspm.fr\/psls\/wp-json\/wp\/v2\/media?parent=47"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}