Skip to content

Update readme #187

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
TobiBu merged 2 commits into from
Jan 16, 2026
Merged

Update readme #187

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ea83c2
Fix image link and enhance installation instructions
anschaible Jan 14, 2026
06738ed
Fix image source URL in README.md
anschaible Jan 14, 2026
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
11 changes: 8 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<p align="center">
<img src="./logo_rubix.png" alt="Rubix Logo" width="30%">
<img src="https://github.com/AstroAI-Lab/rubix/blob/main/logo_rubix.png" alt="Rubix Logo" width="30%">
</p>

# Welcome to RUBIX
Expand All @@ -25,8 +25,13 @@ Key features include:
- **Flexible and Extensible:** Designed to easily integrate with existing pipelines and astrophysical analysis tools.

## Installation
Rubix is on [PyPi](https://pypi.org/project/astro-rubix/). You can install it via

The Python package `rubix` is published on GitHub and can be installed alongside its runtime dependencies (including JAX) by choosing the relevant extras. For a CPU-only environment, install with:
```
pip install astro-rubix
```

Alternatively, the Python package `rubix` is published on GitHub and can be installed alongside its runtime dependencies (including JAX) by choosing the relevant extras. For a CPU-only environment, install with:

```
git clone https://github.com/AstroAI-Lab/rubix.git
Expand Down Expand Up @@ -81,7 +86,7 @@ Please see [here](docs/CONTRIBUTING.md) for contribution guidelines.

Thank you for helping improve `rubix`!

## Citation & Acknowledgement
## Citation

Please cite **both** of the following papers ([Cakir et al. 2024](https://arxiv.org/abs/2412.08265), [Schaible et al. 2025](https://arxiv.org/abs/2511.17110)) if you use Rubix in your research:

Expand Down