Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
46 changes: 22 additions & 24 deletions docs/non-developer-mode-example/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,26 @@
Using Firecrown in non-developer mode
=====================================

An important difference between using Firecrown in developer mode and non-developer mode involves how paths used in likelihood scripts and CosmoSIS `ini` files are specified.
These examples show the correct usage for non-developer mode.

.. toctree::
:maxdepth: 1
:caption: Firecrown likelihood
:name: likelihood

Likelihood script for DES Y1 3x2pt analysis<likelihood.rst>

.. toctree::
:maxdepth: 1
:caption: Using the likelihood with Cobaya
:name: cobaya

Running Cobaya using the likelihood<cobaya.rst>

.. toctree::
:maxdepth: 1
:caption: Using the likelihood with CosmoSIS
:name: cosmosis

Running CosmoSIS using the likelihood<cosmosis.rst>
Example values file used for this analysis<values.rst>
A Firecrown installed from conda-forge, as described in :doc:`../non_developer_installation`, generates the same examples as a developer installation.
The command below writes the DES Y1 3x2pt example into the directory ``des_y1_example``: the SACC data file, the likelihood factory ``des_y1_3x2pt_factory.py``, and the configuration files for the framework chosen with ``--target-framework`` (``cosmosis``, ``cobaya``, or ``numcosmo``).

.. code:: bash

firecrown examples des_y1_3x2pt des_y1_example --target-framework cosmosis

Run the framework from that directory, with the command for the chosen framework:

.. code:: bash

cd des_y1_example
cosmosis cosmosis_des_y1_3x2pt.ini
cobaya-run cobaya_des_y1_3x2pt.yaml
numcosmo run test numcosmo_des_y1_3x2pt.yaml

The generated files refer to each other by relative paths and do not record where Firecrown is installed.
The CosmoSIS configuration loads the Firecrown likelihood through ``firecrown_cosmosis.py``, which imports it from the Python environment that runs CosmoSIS.
The directory can therefore be moved, or copied to another machine with Firecrown installed, and run there.
CosmoSIS also needs the environment variable ``CSL_DIR``, set as described in :doc:`../non_developer_installation`.

``firecrown examples`` lists the available examples, and ``firecrown examples des_y1_3x2pt --help`` describes the options of this one.
The likelihood factory written into the directory is a starting point for a likelihood of your own.
13 changes: 0 additions & 13 deletions docs/non-developer-mode-example/cobaya.rst

This file was deleted.

172 changes: 0 additions & 172 deletions docs/non-developer-mode-example/cobaya_evaluate.yaml

This file was deleted.

40 changes: 0 additions & 40 deletions docs/non-developer-mode-example/cobaya_mcmc.yaml

This file was deleted.

13 changes: 0 additions & 13 deletions docs/non-developer-mode-example/cosmosis.rst

This file was deleted.

44 changes: 0 additions & 44 deletions docs/non-developer-mode-example/des_y1_3x2pt.ini

This file was deleted.

Loading
Loading