improving

Author: EiffL

README.md

@@ -1,12 +1,13 @@
 # SHINE: SHear INference Environment
 
 <div align="center">
-  <img src="assets/logo.png" alt="SHINE Logo" width="1024"/>
+  <img src="https://raw.githubusercontent.com/CosmoStat/SHINE/main/assets/logo.png" alt="SHINE Logo" width="1024"/>
 
   **A JAX-powered framework for probabilistic shear estimation in weak gravitational lensing**
 
   [![Python](https://img.shields.io/badge/python-3.11+-blue.svg)](https://www.python.org/)
   [![JAX](https://img.shields.io/badge/JAX-latest-green.svg)](https://github.com/google/jax)
+  [![PyPI](https://img.shields.io/pypi/v/shine-wl.svg)](https://pypi.org/project/shine-wl/)
   [![Docs](https://img.shields.io/badge/docs-cosmostat.github.io%2FSHINE-7c4dff.svg)](https://cosmostat.github.io/SHINE/)
   [![License](https://img.shields.io/badge/license-MIT-orange.svg)](LICENSE) <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
   [![All Contributors](https://img.shields.io/badge/all_contributors-4-orange.svg)](#contributors-)
@@ -30,12 +31,15 @@ SHINE (SHear INference Environment) is a modern, high-performance framework for
 ## 📦 Installation
 
 ```bash
-# Clone the repository
+pip install shine-wl
+```
+
+For development (editable install from source):
+
+```bash
 git clone https://github.com/CosmoStat/SHINE.git
 cd SHINE
-
-# Install dependencies (recommended: use a virtual environment)
-pip install -e .
+pip install -e ".[dev,test]"
 ```
 
 ## 🚀 Quick Start

docs/getting-started.md

@@ -7,18 +7,26 @@
 - Python >= 3.11
 - A JAX-compatible GPU is recommended but not required
 
-### Install from source
+### Install from PyPI
+
+```bash
+pip install shine-wl
+```
+
+### Install from source (development)
+
+For contributing or working on SHINE itself:
 
 ```bash
 git clone https://github.com/CosmoStat/SHINE.git
 cd SHINE
-pip install -e .
+pip install -e ".[dev,test]"
 ```
 
-For documentation tools:
+Optional extras:
 
 ```bash
-pip install -e ".[docs]"
+pip install -e ".[docs]"   # documentation tools (mkdocs)
 ```
 
 ## Your First Run

docs/index.md

@@ -30,10 +30,8 @@ fast, GPU-accelerated inference using **NumPyro** and **JAX-GalSim**.
 ## Quick Start
 
 ```bash
-# Install
-git clone https://github.com/CosmoStat/SHINE.git
-cd SHINE
-pip install -e .
+# Install from PyPI
+pip install shine-wl
 
 # Run inference
 python -m shine.main --config configs/test_run.yaml

pyproject.toml

@@ -11,8 +11,14 @@ requires-python = ">=3.11"
 authors = [
     {name = "Emma Ayçoberry", email = "emma.aycoberry@cea.fr"},
     {name = "Ezequiel Centofanti", email = "ezequiel.centofanti@cea.fr"},
-    {name = "Sam Farrens", email ="sam.farrens@cea.fr"},
-    {name = "Francois Lanusse", email = "francois.lanusse@cnrs.fr"}
+    {name = "Sam Farrens", email = "sam.farrens@cea.fr"},
+    {name = "Francois Lanusse", email = "francois.lanusse@cnrs.fr"},
+]
+maintainers = [
+    {name = "Emma Ayçoberry", email = "emma.aycoberry@cea.fr"},
+    {name = "Ezequiel Centofanti", email = "ezequiel.centofanti@cea.fr"},
+    {name = "Sam Farrens", email = "sam.farrens@cea.fr"},
+    {name = "Francois Lanusse", email = "francois.lanusse@cnrs.fr"},
 ]
 license = "MIT"
 keywords = ["cosmology", "weak-lensing", "shear", "jax", "astronomy"]
@@ -56,6 +62,12 @@ shine-bias-run = "shine.validation.cli:run_bias_realization"
 shine-bias-extract = "shine.validation.cli:extract_bias_results"
 shine-bias-stats = "shine.validation.cli:compute_bias_statistics"
 
+[project.urls]
+Homepage = "https://github.com/CosmoStat/SHINE"
+Documentation = "https://cosmostat.github.io/SHINE/"
+Repository = "https://github.com/CosmoStat/SHINE"
+Issues = "https://github.com/CosmoStat/SHINE/issues"
+
 [tool.setuptools]
 packages = ["shine", "shine.validation"]