:py:mod:`flip.power_spectra`
============================

.. py:module:: flip.power_spectra

.. autoapi-nested-parse::

   Init file of the flip.power_spectra package.



Submodules
----------
.. toctree::
   :titlesonly:
   :maxdepth: 1

   class_engine/index.rst
   generator/index.rst
   models/index.rst


Package Contents
----------------


Functions
~~~~~~~~~

.. autoapisummary::

   flip.power_spectra.compute_power_spectra



.. py:function:: compute_power_spectra(power_spectrum_engine, power_spectrum_settings, redshift, minimal_wavenumber, maximal_wavenumber, number_points, logspace=True, normalization_power_spectrum='no_normalization', power_spectrum_non_linear_model=None, power_spectrum_model='linearbel', save_path=None)

   Compute the power spectrum.

   :param power_spectrum_engine: engine to use to compute the power spectrum, see _available_engines.
   :type power_spectrum_engine: str
   :param power_spectrum_settings: configuration for the engine.
   :type power_spectrum_settings: dic
   :param redshift: the redshift at which compute the power spectrum.
   :type redshift: float
   :param minimal_wavenumber: minimum k in h/Mpc.
   :type minimal_wavenumber: float
   :param maximal_wavenumber: maximum k in h/Mpc.
   :type maximal_wavenumber: float
   :param number_points: Sampling of the power spectrum.
   :type number_points: int
   :param logspace: Sample the power spectrum in logspace or linspace. Defaults to True.
   :type logspace: bool, optional
   :param normalization_power_spectrum: which normalisation to use. Defaults to "no_normalization".
                                        Available options are: "no_normalization", "growth_rate" or "growth_amplitude".
   :type normalization_power_spectrum: str, optional
   :param power_spectrum_non_linear_model: Non-linear model to compute. Defaults to None.
   :type power_spectrum_non_linear_model: str, optional
   :param power_spectrum_model: Non-linear model to apply to the computed power spectrum, see _available_power_spectrum_model. Defaults to "linearbel".
   :type power_spectrum_model: str, optional
   :param save_path: Path to save the computed power spectrum. Defaults to None.
   :type save_path: str, optional

   :raises ValueError: power_spectrum_engine is not available
   :raises ValueError: power_spectrum_model is not available
   :raises ValueError: _description_

   :returns: _description_
   :rtype: _type_