|
3 | 3 | [](https://badge.fury.io/py/furax-cs) |
4 | 4 | [](https://opensource.org/licenses/MIT) |
5 | 5 | [](https://github.com/pre-commit/pre-commit) |
| 6 | +[](https://furax-cs.readthedocs.io/en/latest/) |
| 7 | +[](https://askabalan-furax-cs-results.hf.space/) |
| 8 | +[](https://arxiv.org/abs/XXXX.XXXXX) |
6 | 9 |
|
7 | 10 | **FURAX-CS** (FURAX Component Separation) is a Python package designed to benchmark and implement advanced component separation techniques for Cosmic Microwave Background (CMB) analysis. It leverages **JAX** for high-performance computing on GPUs and implements novel adaptive clustering methods. |
8 | 11 |
|
@@ -30,6 +33,9 @@ This has an impact on the estimated r tensor-to-scalar ratio as shown in the fig |
30 | 33 |
|
31 | 34 | --- |
32 | 35 |
|
| 36 | + |
| 37 | +> **Interactive Results:** Explore the results from our paper ([PLACEHOLDER](https://arxiv.org/abs/XXXX.XXXXX)) using the [Results Explorer](https://askabalan-furax-cs-results.hf.space/) Streamlit app. |
| 38 | +
|
33 | 39 | ## Installation |
34 | 40 |
|
35 | 41 | ### 1. Prerequisites (JAX) |
@@ -62,10 +68,12 @@ pip install -r https://raw.githubusercontent.com/CMBSciPol/furax-cs/main/require |
62 | 68 |
|
63 | 69 | ## Documentation |
64 | 70 |
|
65 | | -* **[Quick Start (Python API)](docs/quick_start.md)**: Learn how to use the Python API for data loading and running component separation. |
66 | | -* **[CLI Reference & Workflow](docs/cli_reference.md)**: Comprehensive guide on using the command-line interface for the full analysis pipeline. |
67 | | -* **[Minimization Solvers](docs/minimization.md)**: Guide to available optimization algorithms (Active Set, L-BFGS, etc.) and programmatic usage. |
68 | | -* **[Analysis Tools (r_analysis)](docs/r_analysis.md)**: Detailed documentation for the result analysis and plotting suite. |
| 71 | +Full documentation is available at **[furax-cs.readthedocs.io](https://furax-cs.readthedocs.io/en/latest/)**. |
| 72 | + |
| 73 | +* **[Quick Start (Python API)](https://furax-cs.readthedocs.io/en/latest/quick_start.html)**: Learn how to use the Python API for data loading and running component separation. |
| 74 | +* **[CLI Reference & Workflow](https://furax-cs.readthedocs.io/en/latest/cli_reference.html)**: Comprehensive guide on using the command-line interface for the full analysis pipeline. |
| 75 | +* **[Minimization Solvers](https://furax-cs.readthedocs.io/en/latest/minimization.html)**: Guide to available optimization algorithms (Active Set, L-BFGS, etc.) and programmatic usage. |
| 76 | +* **[Analysis Tools (r_analysis)](https://furax-cs.readthedocs.io/en/latest/r_analysis/index.html)**: Detailed documentation for the result analysis and plotting suite. |
69 | 77 |
|
70 | 78 | --- |
71 | 79 |
|
|
0 commit comments