Skip to content

Commit a5db36b

Browse files
committed
Add badges and format
1 parent 0137d18 commit a5db36b

2 files changed

Lines changed: 14 additions & 7 deletions

File tree

README.md

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,9 @@
33
[![PyPI version](https://badge.fury.io/py/furax-cs.svg)](https://badge.fury.io/py/furax-cs)
44
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
55
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
6+
[![Documentation](https://img.shields.io/badge/docs-readthedocs-blue?logo=readthedocs)](https://furax-cs.readthedocs.io/en/latest/)
7+
[![Results Explorer](https://img.shields.io/badge/%F0%9F%A4%97%20Results-Explorer-yellow?)](https://askabalan-furax-cs-results.hf.space/)
8+
[![arXiv](https://img.shields.io/badge/arXiv-XXXX.XXXXX-b31b1b?logo=arxiv)](https://arxiv.org/abs/XXXX.XXXXX)
69

710
**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.
811

@@ -30,6 +33,9 @@ This has an impact on the estimated r tensor-to-scalar ratio as shown in the fig
3033

3134
---
3235

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+
3339
## Installation
3440

3541
### 1. Prerequisites (JAX)
@@ -62,10 +68,12 @@ pip install -r https://raw.githubusercontent.com/CMBSciPol/furax-cs/main/require
6268

6369
## Documentation
6470

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.
6977

7078
---
7179

notebooks/01_FGBuster_vs_FURAX_Comparison.ipynb

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,6 @@
5656
"outputs": [],
5757
"source": [
5858
"# Core scientific computing\n",
59-
"import operator\n",
6059
"from functools import partial\n",
6160
"\n",
6261
"import furax_cs as fcs\n",
@@ -76,7 +75,7 @@
7675
")\n",
7776
"\n",
7877
"# FURAX - Modern JAX-based framework\n",
79-
"from furax import HomothetyOperator , tree\n",
78+
"from furax import HomothetyOperator, tree\n",
8079
"from furax.obs.landscapes import Stokes\n",
8180
"from furax.obs.operators import (\n",
8281
" CMBOperator,\n",
@@ -299,7 +298,7 @@
299298
" # L = (A^T N^-1 d)^T (A^T N^-1 A)^-1 (A^T N^-1 d)\n",
300299
" x = (A.T @ invN)(d) # A^T N^-1 d\n",
301300
" s = (A.T @ invN @ A).I(x)\n",
302-
" L = tree.dot(x, s) \n",
301+
" L = tree.dot(x, s)\n",
303302
"\n",
304303
" return -L # Return negative for minimization"
305304
]

0 commit comments

Comments
 (0)