.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "auto_examples/other/star/plot_flare_lightcurve.py"
.. LINE NUMBERS ARE GIVEN BELOW.

.. only:: html

    .. note::
        :class: sphx-glr-download-link-note

        :ref:`Go to the end <sphx_glr_download_auto_examples_other_star_plot_flare_lightcurve.py>`
        to download the full example code.

.. rst-class:: sphx-glr-example-title

.. _sphx_glr_auto_examples_other_star_plot_flare_lightcurve.py:


Plot the lightcurve of a flaring star
=====================================

This example plots the lightcurve caused by a
flaring star.

.. GENERATED FROM PYTHON SOURCE LINES 8-21

.. code-block:: Python

    from pathlib import Path
    from astropy import units as u
    import matplotlib.pyplot as plt
    import libpypsg

    from VSPEC import ObservationModel,PhaseAnalyzer
    from VSPEC import params
    from VSPEC.params.gcm import vspec_to_pygcm

    SEED = 23
    libpypsg.docker.set_url_and_run()






.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    Saved settings to /home/runner/.libpypsg/settings.json
    Reloading settings...




.. GENERATED FROM PYTHON SOURCE LINES 22-28

Initialize the VSPEC run parameters
-----------------------------------

For this example, we will create the
parameter objects explicitly. This can also
be done using a YAML file.

.. GENERATED FROM PYTHON SOURCE LINES 28-118

.. code-block:: Python


    header = params.Header(
        data_path=Path('.vspec/flare_lightcurve'),
        seed=SEED,verbose=0,
        spec_grid = params.VSPECGridParameters(
            max_teff=3400*u.K,min_teff=3200*u.K,
            impl_bin='rust',impl_interp='scipy',fail_on_missing=False
        )
    )

    star = params.StarParameters(
        psg_star_template='M',
        teff=3300*u.K,
        mass = 0.1*u.M_sun,
        radius=0.15*u.R_sun,
        period = 10*u.day,
        misalignment_dir=0*u.deg,
        misalignment=0*u.deg,
        ld = params.LimbDarkeningParameters.solar(),
        faculae=params.FaculaParameters.none(),
        spots=params.SpotParameters.none(),
        flares=params.FlareParameters(
            dist_teff_mean=9000*u.K,
            dist_teff_sigma=500*u.K,
            dist_fwhm_mean=3*u.hr,
            dist_fwhm_logsigma=0.4,
            alpha=-0.829,
            beta=26.87,
            min_energy=1e32*u.erg,
            cluster_size=3
        ),
        granulation=params.GranulationParameters.none(),
        grid_params=(500, 1000),
    )

    planet = params.PlanetParameters.std(init_phase=180*u.deg,init_substellar_lon=0*u.deg)
    system = params.SystemParameters(
        distance=1.3*u.pc,
        inclination=30*u.deg,
        phase_of_periastron=0*u.deg
    )
    observation = params.ObservationParameters(
        observation_time=3*u.day,
        integration_time=30*u.min
    )
    psg_params = params.psgParameters(
        gcm_binning=200,
        phase_binning=1,
        use_molecular_signatures=True,
        use_continuum_stellar=True,
        nmax=0,
        lmax=0,
        continuum=['Rayleigh', 'Refraction', 'CIA_all'],
    )
    instrument = params.InstrumentParameters.niriss_soss()

    def gcm_getter():
        return vspec_to_pygcm(
            shape=(30,30,30),
            epsilon=7,
            star_teff=3800*u.K,
            r_star=0.2*u.R_sun,
            r_orbit=0.05*u.AU,
            lat_redistribution=0.0,
            p_surf=1*u.bar,
            p_stop=1e-5*u.bar,
            wind_u=0*u.km/u.s,
            wind_v=0*u.km/u.s,
            albedo=0.3,
            emissivity=1.0,
            gamma=1.4,
            molecules={'CO2':1e-4}
        )
    gcm = params.gcmParameters(
        gcm_getter=gcm_getter,
        mean_molec_weight=28,
        is_static=True
    )

    parameters = params.InternalParameters(
        header = header,
        star = star,
        planet = planet,
        system = system,
        obs=observation,
        psg = psg_params,
        inst=instrument,
        gcm = gcm
    )








.. GENERATED FROM PYTHON SOURCE LINES 119-122

Run the simulation
------------------


.. GENERATED FROM PYTHON SOURCE LINES 122-127

.. code-block:: Python


    model = ObservationModel(params=parameters)
    model.build_planet()
    model.build_spectra()





.. rst-class:: sphx-glr-script-out

 .. code-block:: none

    Creating interpolators:
    thermal
    thermal, combined
    thermal, combined, stellar
    thermal, combined, stellar, photon noise
    thermal, combined, stellar, photon noise, detector noise
    thermal, combined, stellar, photon noise, detector noise, telescope noise
    thermal, combined, stellar, photon noise, detector noise, telescope noise, background noise
    thermal, combined, stellar, photon noise, detector noise, telescope noise, background noise, transit
    Finished!

    Loading Spectra:   0%|          | 0/3 [00:00<?, ?it/s]
    Loading Spectra:  33%|███▎      | 1/3 [00:00<00:00,  3.42it/s]
    Loading Spectra:  67%|██████▋   | 2/3 [00:00<00:00,  3.40it/s]
    Loading Spectra: 100%|██████████| 3/3 [00:00<00:00,  3.39it/s]
    Loading Spectra: 100%|██████████| 3/3 [00:00<00:00,  3.39it/s]




.. GENERATED FROM PYTHON SOURCE LINES 128-133

Load in the data
----------------

We can use VSPEC to read in the synthetic
data we just created.

.. GENERATED FROM PYTHON SOURCE LINES 133-148

.. code-block:: Python


    data = PhaseAnalyzer(model.directories['all_model'])

    wl_pixels = [0,300,500,700]
    time = data.time.to(u.day)
    for i in wl_pixels:
        wl = data.wavelength[i]
        lc = data.lightcurve(
            source='star',
            pixel=i,
            normalize=0
        )
        plt.plot(time,lc,label=f'{wl:.1f}')
    plt.legend()
    plt.xlabel(f'time ({time.unit})')
    _=plt.ylabel('Flux (normalized)')


.. image-sg:: /auto_examples/other/star/images/sphx_glr_plot_flare_lightcurve_001.png
   :alt: plot flare lightcurve
   :srcset: /auto_examples/other/star/images/sphx_glr_plot_flare_lightcurve_001.png
   :class: sphx-glr-single-img






.. rst-class:: sphx-glr-timing

   **Total running time of the script:** (6 minutes 5.822 seconds)


.. _sphx_glr_download_auto_examples_other_star_plot_flare_lightcurve.py:

.. only:: html

  .. container:: sphx-glr-footer sphx-glr-footer-example

    .. container:: sphx-glr-download sphx-glr-download-jupyter

      :download:`Download Jupyter notebook: plot_flare_lightcurve.ipynb <plot_flare_lightcurve.ipynb>`

    .. container:: sphx-glr-download sphx-glr-download-python

      :download:`Download Python source code: plot_flare_lightcurve.py <plot_flare_lightcurve.py>`

    .. container:: sphx-glr-download sphx-glr-download-zip

      :download:`Download zipped: plot_flare_lightcurve.zip <plot_flare_lightcurve.zip>`


.. only:: html

 .. rst-class:: sphx-glr-signature

    `Gallery generated by Sphinx-Gallery <https://sphinx-gallery.github.io>`_