============
Examples
============

We provide several examples so users can get a more practical grasp of how to use :code:`redback`. Some examples are listed below:

- `Getting data <https://github.com/nikhil-sarin/redback/blob/master/examples/getting_data_with_redback.py>`_
- `Creating transient objects <https://github.com/nikhil-sarin/redback/blob/master/examples/creating_transient_objects.py>`_
- `Simulate single transient in ztf <https://github.com/nikhil-sarin/redback/blob/master/examples/simulate_single_transient_in_ztf.py>`_
- `Simulate survey <https://github.com/nikhil-sarin/redback/blob/master/examples/simulate_survey.py>`_
- `Simulate basic transient observations <https://github.com/nikhil-sarin/redback/blob/master/examples/simulate_basic_transient.py>`_
- `Using models as a function <https://github.com/nikhil-sarin/redback/blob/master/examples/using_model_as_a_function.py>`_
- `Using SNCosmo models for plotting and fitting data <https://github.com/nikhil-sarin/redback/blob/master/examples/using_sncosmo_models_to_fit.py>`_
- `Modifying models <https://github.com/nikhil-sarin/redback/blob/master/examples/create_your_own_ejecta_relation.py>`_
- `Fitting with homologous expansion <https://github.com/nikhil-sarin/redback/blob/master/examples/supernova_homologous_expansion_example.py>`_
- `Joint GRB afterglow and gravitational-wave analysis <https://github.com/nikhil-sarin/redback/blob/master/examples/joint_grb_gw_example.py>`_
- `Gaussian process with a base model <https://github.com/nikhil-sarin/redback/blob/master/examples/magnetar_example_with_gaussian_process.py>`_
- `broadband_afterglow_private_data_example <https://github.com/nikhil-sarin/redback/blob/master/examples/broadband_afterglow_private_data_example.py>`_
- `fit_your_own_model_example <https://github.com/nikhil-sarin/redback/blob/master/examples/fit_your_own_model_example.py>`_
- `kilonova_example <https://github.com/nikhil-sarin/redback/blob/master/examples/kilonova_example.py>`_
- `magnetar_boosted_example <https://github.com/nikhil-sarin/redback/blob/master/examples/magnetar_boosted_example.py>`_
- `magnetar_example <https://github.com/nikhil-sarin/redback/blob/master/examples/magnetar_example.py>`_
- `prompt_example <https://github.com/nikhil-sarin/redback/blob/master/examples/prompt_example.py>`_
- `supernova_example <https://github.com/nikhil-sarin/redback/blob/master/examples/supernova_example.py>`_
- `tde_example <https://github.com/nikhil-sarin/redback/blob/master/examples/tde_example.py>`_
- `SN2011kl_sample_in_t0_example <https://github.com/nikhil-sarin/redback/blob/master/examples/SN2011kl_sample_in_t0_example.py>`_
- `spectral_template_matching_example <https://github.com/nikhil-sarin/redback/blob/master/examples/spectral_template_matching_example.py>`_
- `Handling non-detections <https://github.com/nikhil-sarin/redback/blob/master/examples/non_detection_example.py>`_
- `Joint multi-messenger fitting <https://github.com/nikhil-sarin/redback/blob/master/examples/multimessenger_example.py>`_
- `Joint spectrum and photometry fitting <https://github.com/nikhil-sarin/redback/blob/master/examples/joint_spectrum_photometry_example.py>`_
- `Joint host-galaxy and transient spectra <https://github.com/nikhil-sarin/redback/blob/master/examples/joint_galaxy_transient_spectrum_example.py>`_

We have also written a more tutorial style `jupyter notebook <https://github.com/nikhil-sarin/redback/blob/master/examples/RedbackTutorial.ipynb>`_
demonstrating the bulk of the functionality of :code:`redback`. There are many more examples in the `examples <https://github.com/nikhil-sarin/redback/blob/master/examples>`_ folder of the repository.
Please check it out!