{"id":271,"date":"2020-11-18T10:51:07","date_gmt":"2020-11-18T09:51:07","guid":{"rendered":"https:\/\/sites.lesia.obspm.fr\/psls\/?page_id=271"},"modified":"2025-09-03T17:27:19","modified_gmt":"2025-09-03T15:27:19","slug":"configuration-file","status":"publish","type":"page","link":"https:\/\/sites.lesia.obspm.fr\/psls\/configuration-file\/","title":{"rendered":"Configuration file"},"content":{"rendered":"<p>The parameters in the configuration file are explained below. An example named <em>psms.yaml<\/em> is also provided in the package.<\/p>\n<p><strong>Observation<\/strong>:<\/p>\n<ul>\n<li><strong>Duration<\/strong> :\u00a0 Simulation duration [days]<\/li>\n<li><strong>MasterSeed<\/strong> :\u00a0 Master seed of the pseudo-random number generator (integer number)<\/li>\n<li><strong> Gaps<\/strong>:\n<ul>\n<li><strong>Enable<\/strong>: include\u00a0 [1] or not [0] gaps<\/li>\n<li><strong>Seed<\/strong>:\u00a0 Seed of the pseudo-random number generator used to generate the gaps ; negative value if controlled by MasterSeed<\/li>\n<li><strong>InterQuarterGapDuration<\/strong>:\u00a0 Duration of the inter-quarter interruptions [days] ; inter-quarter gaps are ignored if zero or negative value ; nominal value: 3<\/li>\n<li><strong>RandomGapDuration<\/strong>:\u00a0 Duration of the random interruptions [minutes] ; random gaps are ignored if zero or negative value ; nominal value: 0<\/li>\n<li><strong>RandomGapTimeFraction<\/strong>: fraction [in %] of the total time lost by the random gaps ; random gaps are ignored if zero or negative value ; nominal value: 0.5<\/li>\n<li><strong>RandomGapStep<\/strong>: Random gap step in % ; nominal value: 0<\/li>\n<li><strong>PeriodicGapCadence<\/strong>: Cadence of the periodic interruptions [days] ; periodic gaps are ignored if zero or negative value ; nominal value: 5.<\/li>\n<li><strong>PeriodicGapDuration<\/strong>: Duration of each periodic interruption [minutes] ; periodic gaps are ignored if zero or negative value ; nominal value: 20<\/li>\n<li><strong>PeriodicGapJitter<\/strong>:\u00a0 Jitter in the time instants the periodic gaps occur [hours] ; normal distribution assumed ; nominal value: 2.<\/li>\n<li><strong>PeriodicGapStep<\/strong>: Periodic gap step in % ; nominal value: 0<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<p><strong>Instrument<\/strong>:<\/p>\n<ul>\n<li><strong>Sampling<\/strong> :\u00a0 Sampling cadence [s] (nominal value: 25s)<\/li>\n<li><strong>IntegrationTime<\/strong> : Integration time [s] (nominal value: 21s)<\/li>\n<li><strong>GroupID<\/strong>:\u00a0 IDs of the camera groups included in the simulation, example [2,3] to simulate group 2 and group 3.\u00a0 Nominal value: [1,2,3,4].<\/li>\n<li><strong>NCamera<\/strong> : Number of cameras per group (1 -&gt; 6) (nominal value: 6)<\/li>\n<li><strong>TimeShift<\/strong> : Time shift between camera groups [s] (nominal value: 6.25s)<\/li>\n<li><strong>RandomNoise<\/strong>:\n<ul>\n<li><strong>Enable<\/strong>:\u00a0 active [1] or dis-activate [0]\u00a0 the random noise<\/li>\n<li><strong>Type<\/strong>:\u00a0 type of random noise, either &lsquo;User&rsquo; or &lsquo;PLATO_SCALING&rsquo; or &lsquo;PLATO_SIMU&rsquo;.\n<ul>\n<li>&lsquo;User&rsquo;: the NSR value is specified by the user (see below)<\/li>\n<li>&lsquo;PLATO_SCALING&rsquo;: the NSR value is obtained by interpolating, at the given magnitude, the NSR scaling relation expected for PLATO<\/li>\n<li>&lsquo;PLATO_SIMU&rsquo;: the NSR is taken from realistic simulated ligth-curves (stored in the systematics error table, see below) and vary with the mask shapes and thus then the latter are updated<\/li>\n<\/ul>\n<\/li>\n<li><strong>NSR<\/strong> : User-specified Noise to Signal Ratio [ppm in one hour] for a single camera. This value takes into account all random noises but does not include systematic errors.<\/li>\n<li><strong>Systematics<\/strong>:\n<ul>\n<li><strong>Enable<\/strong> : active [1] or dis-activate [0]\u00a0 the\u00a0 systematic errors<\/li>\n<li><strong>Table<\/strong>: name of the binary file containing the parameters for the systematic errors<\/li>\n<li><strong>Version<\/strong>: table version\u00a0 (the latest version is recommended2)<\/li>\n<li><strong>DriftLevel<\/strong>:\u00a0 Amplitude of the drift. Can be either\u00a0 &lsquo;min&rsquo;, &lsquo;low&rsquo;, &lsquo;medium&rsquo;, &lsquo;high&rsquo;, &lsquo;max&rsquo; or &lsquo;any&rsquo;. Applicable only for Version&gt;0<\/li>\n<li><strong>Seed<\/strong>: Seed of the pseudo-random number generator used for the systematic errors ; negative value if controlled by MasterSeed<\/li>\n<li>\n<p align=\"justify\">Note: When systematic errors are enabled, PSLS picks from the systematic error table the target with magnitude close to the magnitude specified by the user (within a +\/- 0.25 around the magnitude specified below by the user) and with a drift amplitude in a given range of amplitude (low: 0-0.4 px\/90days, medium: 0.4-0.8 px\/90days, and high: &gt;0.8 pix\/90days). When several targets fulfil the criteria (magnitude and drift level), PSLS randomly selects one of those.<\/p>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<p><strong>Star<\/strong>:<\/p>\n<ul>\n<li><strong>Mag<\/strong> : V magnitude (John V magnitude). The V magnitude is converted into the PLATO P magnitude using the star effective temperature following Marchiori et al (2019, A&amp;A)&rsquo;s Teff-magnitude relation.<\/li>\n<li><strong>ID<\/strong> : star ID (an arbitrary integer number)<\/li>\n<li><strong>ModelDir<\/strong>: Directory containing the pulsation models (a single ADIPLS file, a grid of ADIPLS files, or a simple TEXT file, see below)<\/li>\n<li><strong>ModelType<\/strong>: Type of pulsation model, this can be either &lsquo;UP&rsquo;, &lsquo;grid&rsquo;, &lsquo;grid-old&rsquo; &lsquo;single&rsquo;, or &lsquo;text&rsquo;.\u00a0 The option &lsquo;grid-old&rsquo; shall be used with the old type of grid, the new one being stored in HDF5 files<\/li>\n<li><strong>ModelName<\/strong>:\u00a0 Name of the input pulsation model, to be specified when ModelType = &lsquo;single&rsquo; or &lsquo;text&rsquo;.\u00a0 The input pulsation model can be either a .gsm file (generated by ADIPLS),\u00a0 a simple TEXT file, \u00a0 or an HDF5 file storing a grid of CESAM2K models. In the cas of a TEXT file, the latter shall provide the mode properties (in 3 columns: frequency, width and height). Mode frequencies and mode widths are in muHz and mode heights are in ppm^2\/muHz. For the mode heights a \u00ab\u00a0single-sided\u00a0\u00bb spectrum is assumed.<\/li>\n<li><strong>ES<\/strong> :\u00a0 Evolutionary status,\u00a0 &lsquo;ms&rsquo; for the main-sequence phase, &lsquo;sg&rsquo; for the sub-giant phase, &lsquo;rg&rsquo; for redgiants (Red Giant Branch or clump stars)<\/li>\n<li><strong>Teff<\/strong> :\u00a0 Star effective temperature [K]<\/li>\n<li><strong>Logg<\/strong> :\u00a0 Surface gravity, ignored when ModelType = &lsquo;UP&rsquo;<\/li>\n<li><strong>SurfaceRotationPeriod<\/strong> : Surface rotation period [days], not used when ModelType = &lsquo;UP&rsquo;<\/li>\n<li><strong>CoreRotationFreq<\/strong> : \u00a0 Core rotation frequency [muHz], this is by definition Omega\/2pi*1e6 where Omega is the angular rate [rad\/s], used only when ModelType = &lsquo;UP&rsquo;<\/li>\n<li><strong>Inclination<\/strong> :\u00a0 Inclination angle [deg.]<\/li>\n<li><strong>Seed<\/strong>:\u00a0 Seed of the pseudo-random number generator used to stellar signal (activity, granulation, and oscillations ; spot excluded) ; negative value if controlled by MasterSeed<\/li>\n<\/ul>\n<p><strong>Oscillations<\/strong>:<\/p>\n<ul>\n<li><strong>Enable<\/strong>: include\u00a0 [1] or not [0]\u00a0 the solar-like oscillations<\/li>\n<li><strong>numax<\/strong> : frequency at maximum power [muHZ], used only when ModelType = &lsquo;UP&rsquo;<\/li>\n<li><strong>delta_nu<\/strong> : \u00a0 Mean large separation [muHz], used only when ModelType = &lsquo;UP&rsquo; , -1 if you want this parameter to be derived from a scaling relation<\/li>\n<li><strong>DPI<\/strong> : Asymptotic values of the gravity mode period spacing [s], used only when ModelType = &lsquo;UP&rsquo;, -1 if you don&rsquo;t want mixed modes to be included<\/li>\n<li><strong>q<\/strong> :\u00a0 Mixed mode coupling factor, used only when ModelType = &lsquo;UP&rsquo;<\/li>\n<li><strong>SurfaceEffects<\/strong>: 1 Include near-surface effects in mode frequencies, not implemented when ModelType = &lsquo;UP&rsquo;<\/li>\n<li><strong>Seed<\/strong>: Seed of the pseudo-random number generator used to simulate the oscillations component ; negative value if controlled by MasterSeed<\/li>\n<\/ul>\n<p><strong>Activity<\/strong> :<\/p>\n<ul>\n<li><strong>Enable<\/strong>: include\u00a0 [1] or not [0]\u00a0 stochastic activity component (Lorentzian component). Should not be used when spot modulation is enabled (see below). Not operating when ModelType = \u00ab\u00a0UP\u00a0\u00bb.<\/li>\n<li><strong>Sigma<\/strong> :\u00a0 Amplitude of the activity component [ppm]<\/li>\n<li><strong>Tau<\/strong> : Time-scale of the activity component [days]<\/li>\n<li><strong>Seed<\/strong>: Seed of the pseudo-random number generator used to simulate the (stochastic) activity component ; negative value if controlled by MasterSeed<\/li>\n<li><strong>Spot<\/strong>:\n<ul>\n<li><strong> Enable<\/strong>: include\u00a0 [1] or not [0] stellar spots<\/li>\n<li><strong>dOmega<\/strong>:\u00a0 Differential rotation, dimensionless<\/li>\n<li><strong>MuStar<\/strong>:\u00a0 Limb darkening coefficient of the star (a linear limb darkening law is assumed)<\/li>\n<li><strong>MuSpot<\/strong>:\u00a0 Limb darkening coefficient of the spot<\/li>\n<li><strong>Radius<\/strong>:\u00a0 Spots radii, in degrees, as many values as spots modelled<\/li>\n<li><strong>Latitude<\/strong>: Spots latitudes, in degrees<\/li>\n<li><strong>Longitude<\/strong>:\u00a0 Spots latitudes, in degrees<\/li>\n<li><strong>Lifetime<\/strong>: lifetime of the spot in days<\/li>\n<li><strong>TimeMax<\/strong>: The time of maximum spot contrast, in days. Negative value if you want to be drawn randomly<\/li>\n<li><strong>Contrast<\/strong>: Maximum contrast of the spot (flux of the spot in units of unspotted stellar flux), dimensionless<\/li>\n<li><strong>Modulation<\/strong>: Modulation period of the spot radii [days], ignored if negative or zero value\u00a0 ; default value: 0<\/li>\n<li><strong>Seed<\/strong>:\u00a0 Seed of the pseudo-random number generator used to generate TimeMax ; negative value if controlled by MasterSeed<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<div>\n<ul>\n<li><strong>Flare<\/strong>:\n<ul>\n<li><strong>Enable<\/strong>: 0 # include\u00a0 [1] or not [0] flares<\/li>\n<li><strong>MeanPeriod<\/strong>: 2 # mean period btw 2 flares (days)<\/li>\n<li><strong>Amplitude<\/strong>: 2500. # mean flares amplitudes (ppm) ; the flares amplitudes are drawn from normal distribution centred at FlareAmplitude and with a dispersion of FlareAmplitude \/ 10<\/li>\n<li><strong>UpDown<\/strong>: 0.1 # Ratio of the time taken for the flow to rise to the time taken for the flow to fall<\/li>\n<li><strong>MeanDuration<\/strong>: -1 # mean flare duration (days). If negative, MeanDuration = MeanPeriod\/5<\/li>\n<li><strong>DurationDispersion<\/strong>: -1 # dispersion in the flare duration (days). If negative,\u00a0 DurationDispersion = MeanPeriod\/20<\/li>\n<li><strong>Seed<\/strong>: -1 # Seed of the pseudo-random number generator used to generate the flares. Negative value if controlled by MasterSeed<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/div>\n<p><strong>Granulation<\/strong> :<\/p>\n<ul>\n<li><strong>Enable<\/strong>: include\u00a0 [1] or not [0] stellar granulation<\/li>\n<li><strong>Type<\/strong>:\u00a0 Model type. 0-&gt; single Lorentzian component ; 1-&gt; Kallinger et al(2014)&rsquo;s empirical model<\/li>\n<li><strong>Seed<\/strong>: Seed of the pseudo-random number generator used to simulate the granulation component ; negative value if controlled by MasterSeed<\/li>\n<\/ul>\n<p><strong>Transit<\/strong> :<\/p>\n<ul>\n<li><strong>Enable<\/strong>: include\u00a0 [1] or not [0] planetary transits<\/li>\n<li><strong>PlanetRadius<\/strong> : planet raidus [jupiter radii]<\/li>\n<li><strong>OrbitalPeriod<\/strong> : orbilat period [days]<\/li>\n<li><strong>PlanetSemiMajorAxis<\/strong> : semi major axis [A.U.]<\/li>\n<li><strong>OrbitalAngle<\/strong> : orbital angle [deg]<\/li>\n<li><strong>LimbDarkeningCoefficients<\/strong>: limb darkening coefficients (2 or 4 coefficients). 2 for quadratic law and 4 for a non-linear low<\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"<p>The parameters in the configuration file are explained below. An example named psms.yaml is also provided in the package. Observation: Duration :\u00a0 Simulation duration [days] MasterSeed :\u00a0 Master seed of the pseudo-random number generator (integer number) Gaps: Enable: include\u00a0 [1] or not [0] gaps Seed:\u00a0 Seed of the pseudo-random number generator used to generate the [&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-271","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/sites.lesia.obspm.fr\/psls\/wp-json\/wp\/v2\/pages\/271","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/sites.lesia.obspm.fr\/psls\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/sites.lesia.obspm.fr\/psls\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/sites.lesia.obspm.fr\/psls\/wp-json\/wp\/v2\/users\/47"}],"replies":[{"embeddable":true,"href":"https:\/\/sites.lesia.obspm.fr\/psls\/wp-json\/wp\/v2\/comments?post=271"}],"version-history":[{"count":25,"href":"https:\/\/sites.lesia.obspm.fr\/psls\/wp-json\/wp\/v2\/pages\/271\/revisions"}],"predecessor-version":[{"id":474,"href":"https:\/\/sites.lesia.obspm.fr\/psls\/wp-json\/wp\/v2\/pages\/271\/revisions\/474"}],"wp:attachment":[{"href":"https:\/\/sites.lesia.obspm.fr\/psls\/wp-json\/wp\/v2\/media?parent=271"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}