firecrown.app.cosmology
=======================

.. py:module:: firecrown.app.cosmology

.. autoapi-nested-parse::

   Cosmology configuration generator.

   This module provides a CLI command to generate cosmology configuration files for
   parameter estimation and inference. The generated YAML contains cosmological
   parameter specifications with default values and optional prior constraints.



Classes
-------

.. autoapisummary::

   firecrown.app.cosmology.Cosmology
   firecrown.app.cosmology.PriorWrapper
   firecrown.app.cosmology.Generate


Module Contents
---------------

.. py:class:: Cosmology

   Bases: :py:obj:`enum.StrEnum`

   .. autoapi-inheritance-diagram:: firecrown.app.cosmology.Cosmology
      :parts: 1


   Supported cosmologies.


   .. py:attribute:: VANILLA_LCDM
      :value: 'vanilla_lcdm'



   .. py:attribute:: VANILLA_LCDM_WITH_NEUTRINOS
      :value: 'vanilla_lcdm_with_neutrinos'



.. py:class:: PriorWrapper(/, **data)

   Bases: :py:obj:`pydantic.BaseModel`

   .. autoapi-inheritance-diagram:: firecrown.app.cosmology.PriorWrapper
      :parts: 1


   Wrapper for prior dictionary.


   .. py:attribute:: model_config

      Configuration for the model, should be a dictionary conforming to [`ConfigDict`][pydantic.config.ConfigDict].



   .. py:attribute:: value
      :type:  firecrown.app.analysis.Prior


.. py:class:: Generate

   Bases: :py:obj:`firecrown.app.logging.Logging`

   .. autoapi-inheritance-diagram:: firecrown.app.cosmology.Generate
      :parts: 1


   Cosmology configuration generator.


   .. py:attribute:: output_file
      :type:  Annotated[pathlib.Path, typer.Argument(help='Output file path for generated configuration.')]


   .. py:attribute:: cosmology
      :type:  Annotated[Cosmology, typer.Option('--cosmology', '-c', help='Cosmology to generate configuration for.')]


   .. py:attribute:: camb_halofit
      :type:  Annotated[str | None, typer.Option('--camb-halofit', help='Add CAMB halofit extra parameters to the cosmology.')]
      :value: None



   .. py:attribute:: parameter
      :type:  Annotated[list[str], typer.Option('--parameter', '-p', help='Update parameter values and/or priors. Can be used to set default values, add prior constraints, or both. Use multiple times. Examples: --parameter m_nu=0.06,mean=0.06,sigma=0.01 --parameter Omega_c=0.26,lower=0.2,upper=0.3 --parameter sigma8,mean=0.8,sigma=0.1', default_factory=list)]


   .. py:attribute:: exclude_defaults
      :type:  Annotated[bool, typer.Option('--exclude-defaults', '-e', help='Exclude fields with default values.')]
      :value: False



   .. py:attribute:: print_output
      :type:  Annotated[bool, typer.Option('--print-output', help='Print generated YAML to console (in addition to file).')]
      :value: False



   .. py:method:: __post_init__()

      Initialize and execute the complete cosmology generation workflow.