firecrown.connector.numcosmo.helpers
====================================

.. py:module:: firecrown.connector.numcosmo.helpers

.. autoapi-nested-parse::

   Helper functions and classes for the NumCosmo connector.



Classes
-------

.. autoapisummary::

   firecrown.connector.numcosmo.helpers.PowerSpec


Functions
---------

.. autoapisummary::

   firecrown.connector.numcosmo.helpers.get_hiprim
   firecrown.connector.numcosmo.helpers.get_amplitude_parameters


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

.. py:function:: get_hiprim(hi_cosmo)

   Return the HIPrim object from a NumCosmo HICosmo object.

   If hi_cosmo does not have a HIPrim object, a ValueError is raised.
   If the HIPrim object is not of type HIPrimPowerLaw, a ValueError is raised.

   :param hi_cosmo: NumCosmo HICosmo object
   :return: the HIPrim object contained in hi_cosmo


.. py:function:: get_amplitude_parameters(amplitude_parameter, p_ml, hi_cosmo)

   Calculate the amplitude parameters for CCL.

   :param ccl_factory: the CCL factory object
   :param p_ml: the NumCosmo PowspecML object, or None
   :param hi_cosmo: the NumCosmo cosmology object
   :return: a tuple of the amplitude parameters, (A_s, sigma8), with only one set.


.. py:class:: PowerSpec(linear=Nc.PowspecML, nonlinear=None | Nc.PowspecMNL)

   Represents a power spectrum with linear and optional nonlinear components.


   .. py:attribute:: linear


   .. py:attribute:: nonlinear


   .. py:method:: prepare_if_needed(hi_cosmo)

      Prepare the power spectrum objects if needed.

      :param hi_cosmo: the NumCosmo HICosmo object