.. _examples:

Examples
========

Welcome to CG's examples library! On this page, you should be able to find a wide
array of example scripts for a variety of purposes. Look out for the tags on each example to
see what fits your use case, existing knowledge, and time frame.

Using CG
---------

.. card-carousel:: 3

    .. card:: Your First Journey with CG
        :link: _notebooks/examples/FirstJourney
        :link-type: doc

        Learn the basics of CG while taking a model of galaxy cluster Abell 133
        all the way from literature to RAMSES simulation. This guide will show you
        the basic pipeline from analytical profiles to actually running a simulation.

        +++

        |beginner| |20min|

    .. card:: The Gravitational Wonderland

        Learn the is and outs of CG's non-Newtonian gravitational theories in this
        step by step guide for producing MONDian simulations.


        +++

        |beginner| |20min| |feature| |nyi|

    .. card:: Collections

        Learn how to pull cluster models directly from literature using the
        :py:mod:`collection` module.

        +++

        |beginner| |10min| |feature| |nyi|
    .. card:: Virialization Methods

        Learn about the ins and outs of virialization in CG's initial conditions.

        +++

        |intermediate| |20min| |nyi|
    .. card:: Correcting Non-Physical Behaviors

        In this guide, we consider the cluster A133 and its analytical model, which is
        non-physical in certain radii. We show the tools available for correcting these
        issues.

        +++

        |beginner| |20min| |nyi|


.. raw:: html

   <hr style="height:10px;background-color:black">

Code Guides - Going From Code To Science
----------------------------------------

.. card-carousel:: 3

    .. card:: RAMSES

        In this guide, we show you how to run a simulation in RAMSES from CG models.

        +++

        |intermediate| |20min| |nyi|

    .. card:: GADGET

        In this guide, we show you how to run a simulation in GADGET from CG models.

        +++

        |intermediate| |20min| |nyi|

    .. card:: ATHENA

        In this guide, we show you how to run a simulation in ATHENA from CG models.

        +++

        |intermediate| |20min| |nyi|

    .. card:: GIZMO

        In this guide, we show you how to run a simulation in GIZMO from CG models.

        +++

        |intermediate| |20min| |nyi|

    .. card:: FLASH

        In this guide, we show you how to run a simulation in FLASH from CG models.

        +++

        |intermediate| |20min| |nyi|

.. raw:: html

   <hr style="height:10px;background-color:black">

Beyond CG - External Packages
-----------------------------

.. card-carousel:: 3

    .. card:: CG with YT

        In this guide, we'll discuss using CG with the `YT <https://yt-project.org/doc/index.html>`_ package.

        +++

        |intermediate| |20min| |nyi|

    .. card:: PynBody

        In this guide, we'll discuss using CG with the `pynbody <https://pynbody.github.io/>`_ package.

        +++

        |intermediate| |20min| |nyi|

    .. card:: Pyxsim + SOXS

        In this guide, we'll discuss using CG with the `PyXSIM <https://github.com/jzuhone/pyxsim>`_ package.

        +++

        |nyi|


.. raw:: html

   <hr style="height:10px;background-color:black">

Developing in CG
--------------------

.. card-carousel:: 3

    .. card:: Adding New Gravity

        In this guide, we show you how to run a simulation in RAMSES from CG models.

        +++

        |advanced| |20min| |nyi|

.. |beginner| image:: https://img.shields.io/badge/Difficulty-Beginner-green
.. |intermediate| image:: https://img.shields.io/badge/Difficulty-Intermediate-blue
.. |advanced| image:: https://img.shields.io/badge/Difficulty-Advanced-black
.. |10min| image:: https://img.shields.io/badge/10min-blue
.. |20min| image:: https://img.shields.io/badge/20min-blue
.. |30min| image:: https://img.shields.io/badge/30min-blue
.. |40min| image:: https://img.shields.io/badge/40min-blue
.. |60min| image:: https://img.shields.io/badge/60min-blue
.. |feature| image:: https://img.shields.io/badge/Feature-purple
.. |nyi| image::  https://img.shields.io/badge/NotYetImplemented-red