Skip to content

Commit

Permalink
improve instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
santiagocasas committed Oct 29, 2024
1 parent 67f24e1 commit 6000ccd
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 2 deletions.
40 changes: 39 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -46,14 +46,52 @@ Topo in Spanish is Mole, which gives the idea of blinding.

``cobaya-install cosmo -p cosmo/``

:TOPO-Cobaya example likelihood installation:
:TOPO-Cobaya example likelihood installation of dependencies:

``cobaya-install --upgrade scripts/BAOs.yaml``

:TOPO-Cobaya example likelihood run:

``cobaya-run scripts/BAOs.yaml``

:TOPO-Cobaya example likelihood run of Gaussian mixture likelihood:

``cobaya-run scripts/gaussianmix.yaml``

*TOPO-Cobaya* example of a successful verification
==================================================

This section explains how to run and verify an example analysis with TOPO-Cobaya.
The example run is a simple Gaussian mixture likelihood.
The script to run this analysis is located at ``scripts/gaussianmix.yaml``.
It contains a random seed, which is necessary for the verification process to be reproducible.

Type ``topocobaya -h`` in the command line to see the available commands.

:Create a new private key:

``topocobaya keygen``
## encrypt your key with a password for more security

:Freeze your analysis pipeline and create a pre-commit object:

``topocobaya freeze -p scripts/gaussianmix.yaml``

:Run your analysis:

``cobaya-run scripts/gaussianmix.yaml``

:Generate proof of your analysis:

``topocobaya proof -p scripts/gaussianmix.yaml``

:Verify the proof of your analysis:

``topocobaya verify -p scripts/gaussianmix.yaml``

If the verification is successful, you will see the following message:

``Full Verfiication completed! sTOPOing cobaya! ``
*Cobaya*, a code for Bayesian analysis in Cosmology
Expand Down
2 changes: 1 addition & 1 deletion topo/Verify.py
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ def run_verification(pre_hash, ident, input_yaml, proof, params, name):

return
elif level == -99:
print("Full Verfiication completed! Stoppoing cobaya! ")
print("Full Verfiication completed! sTOPOing cobaya! ")
cobaya.terminate() # Use terminate to allow for a graceful shutdown

try:
Expand Down

0 comments on commit 6000ccd

Please sign in to comment.