.. DO NOT EDIT.
.. THIS FILE WAS AUTOMATICALLY GENERATED BY SPHINX-GALLERY.
.. TO MAKE CHANGES, EDIT THE SOURCE PYTHON FILE:
.. "auto_examples/other/star/plot_faculae_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_faculae_lightcurve.py>`
        to download the full example code

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

.. _sphx_glr_auto_examples_other_star_plot_faculae_lightcurve.py:


Plot the lightcurve of a star with faculae
==========================================

This example plots the lightcurve caused by a
 photosphere covered in faculae.

.. GENERATED FROM PYTHON SOURCE LINES 8-20

.. code-block:: Python

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

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

    SEED = 24
    pypsg.docker.set_url_and_run()





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

 .. code-block:: none

    Saved settings to /home/ted/.pypsg/settings.json
    Reloading settings...




.. GENERATED FROM PYTHON SOURCE LINES 21-27

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 27-122

.. code-block:: Python


    header = params.Header(
        data_path=Path('.vspec/faclae_lightcurve'),
        teff_min=2300*u.K,
        teff_max=3900*u.K,
        seed=SEED, verbose=0
    )
    star = params.StarParameters(
        psg_star_template='M',
        teff=3000*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(
            distribution='iso',
            equillibrium_coverage=0.01,
            burn_in=2*u.day,
            mean_radius=0.01*u.R_sun,
            logsigma_radius=0.3,
            depth=0.01*u.R_sun,
            mean_timescale=1*u.day,
            logsigma_timescale=0.2,
            floor_teff_slope=0*u.K/u.km,
            floor_teff_min_rad=100*u.km,
            floor_teff_base_dteff=-100*u.K,
            wall_teff_slope=0*u.K/u.km,
            wall_teff_intercept=100*u.K
        ),
        spots=params.SpotParameters.none(),
        flares=params.FlareParameters.none(),
        granulation=params.GranulationParameters.none(),
        grid_params=10000,
        spectral_grid='default'
    )

    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_periasteron=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 123-126

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


.. GENERATED FROM PYTHON SOURCE LINES 126-131

.. code-block:: Python


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





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

 .. code-block:: none


    Loading Spectra:   0%|          | 0/17 [00:00<?, ?it/s]
    Loading Spectra:   6%|▌         | 1/17 [00:00<00:04,  3.43it/s]
    Loading Spectra:  12%|█▏        | 2/17 [00:00<00:04,  3.40it/s]
    Loading Spectra:  18%|█▊        | 3/17 [00:00<00:04,  3.40it/s]
    Loading Spectra:  24%|██▎       | 4/17 [00:01<00:03,  3.41it/s]
    Loading Spectra:  29%|██▉       | 5/17 [00:01<00:03,  3.41it/s]
    Loading Spectra:  35%|███▌      | 6/17 [00:01<00:03,  3.42it/s]
    Loading Spectra:  41%|████      | 7/17 [00:02<00:02,  3.43it/s]
    Loading Spectra:  47%|████▋     | 8/17 [00:02<00:02,  3.43it/s]
    Loading Spectra:  53%|█████▎    | 9/17 [00:02<00:02,  3.44it/s]
    Loading Spectra:  59%|█████▉    | 10/17 [00:02<00:02,  3.45it/s]
    Loading Spectra:  65%|██████▍   | 11/17 [00:03<00:01,  3.45it/s]
    Loading Spectra:  71%|███████   | 12/17 [00:03<00:01,  3.45it/s]
    Loading Spectra:  76%|███████▋  | 13/17 [00:03<00:01,  3.45it/s]
    Loading Spectra:  82%|████████▏ | 14/17 [00:04<00:00,  3.45it/s]
    Loading Spectra:  88%|████████▊ | 15/17 [00:04<00:00,  3.45it/s]
    Loading Spectra:  94%|█████████▍| 16/17 [00:04<00:00,  3.45it/s]
    Loading Spectra: 100%|██████████| 17/17 [00:04<00:00,  3.46it/s]
    Loading Spectra: 100%|██████████| 17/17 [00:04<00:00,  3.44it/s]




.. GENERATED FROM PYTHON SOURCE LINES 132-137

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

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

.. GENERATED FROM PYTHON SOURCE LINES 137-140

.. code-block:: Python


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








.. GENERATED FROM PYTHON SOURCE LINES 141-145

Get the lightcurve
------------------

We will look in a few different wavelengths.

.. GENERATED FROM PYTHON SOURCE LINES 145-159

.. code-block:: Python


    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_faculae_lightcurve_001.png
   :alt: plot faculae lightcurve
   :srcset: /auto_examples/other/star/images/sphx_glr_plot_faculae_lightcurve_001.png
   :class: sphx-glr-single-img






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

   **Total running time of the script:** (1 minutes 54.880 seconds)


.. _sphx_glr_download_auto_examples_other_star_plot_faculae_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_faculae_lightcurve.ipynb <plot_faculae_lightcurve.ipynb>`

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

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


.. only:: html

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

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