Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
TomLaclavere authored Sep 11, 2024
1 parent aa2df8f commit 43a9d23
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
# Description

Repository to perform End-to-end simulations of data acquisition and sky reconstruction with the QUBIC instrument. The reconstruction can be based on two different methods : the Frequency Map-Making (link arXiv) & the Component Map-Making (lien arXiv).
Repository to perform End-to-end data acquisition and sky reconstruction simulations with the QUBIC instrument. The reconstruction can be based on two different methods: the Frequency Map-Making (link arXiv) & the Component Map-Making (lien arXiv).

The code documentation can be find following : https://mathias77515.github.io/Pipeline/docs/html/index.html
The code documentation can be found here: https://mathias77515.github.io/Pipeline/docs/html/index.html .

# src

src repository contains all the codes to perform the simulations and a large part of the analysis of the reconstructed sky maps : compute power spectra & fit cosmological/astrophysical parameters.
src repository contains all the codes to perform the simulations and a large part of the analysis of the reconstructed sky maps: compute power spectra & fit cosmological/astrophysical parameters.

# docs

docs repository contains the files to build the API documentation.

## Documentation tutorial

The API documentation is build using Sphinx (https://www.sphinx-doc.org/en/master/index.html). A general way to build it :
The API documentation is built using Sphinx (https://www.sphinx-doc.org/en/master/index.html). A general way to build it by following :

```
sphinx-apidoc -Mfeo docs/ path_to_package
sphinx-build docs/ docs/html
```

The first line is used to build .rst files by reading the code in the package given by path_to_package (for example : src/CMM). These files are stored in docs but are not save on Github for simplicity.
The second line is used to read the .rst files and to convert them in .html files, which we use to generate the API documentation.
After a modification, if you want to visualise the documentation before commited it, you can use Firefox (or any other application) following :
The first line is used to build .rst files by reading the code in the package given by path_to_package (for example src/CMM). These files are stored in docs but not saved on Github for simplicity.
The second line reads the .rst files and converts them into .html files, which we use to generate the API documentation.
After a modification, if you want to visualize the documentation before committing it, you can use Firefox (or any other application) :

```
firefox docs/html/index.html
Expand Down

0 comments on commit 43a9d23

Please sign in to comment.