From e8002e68350f25eb5a9a897fa531774b480cdb25 Mon Sep 17 00:00:00 2001 From: Sergio Souza Costa Date: Thu, 8 Oct 2026 13:29:36 -0300 Subject: [PATCH] docs: install from PyPI (pip install disscube); PyPI and DOI badges --- README.md | 11 ++++++++++- docs/index.md | 9 ++++++++- 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 880ff66..e17d51e 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,8 @@ [![CI](https://github.com/DisSModel/disscube/actions/workflows/ci.yml/badge.svg)](https://github.com/DisSModel/disscube/actions/workflows/ci.yml) [![Docs](https://github.com/DisSModel/disscube/actions/workflows/docs.yml/badge.svg)](https://dissmodel.github.io/disscube/) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) +[![PyPI](https://img.shields.io/pypi/v/disscube.svg)](https://pypi.org/project/disscube/) +[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.23172450.svg)](https://doi.org/10.5281/zenodo.23172450) > **Status: Alpha — stable APIs for the core pipeline; declarative models still evolving.** @@ -20,11 +22,18 @@ A **source** (`SpatialSource`) goes through a **derivation** (`SpatialDerivation ## Installation +```bash +pip install disscube # from PyPI +pip install "disscube[dissmodel]" # + hand-off of the cube to DisSModel models +``` + +From a clone, for development: + ```bash git clone https://github.com/DisSModel/disscube.git cd disscube python -m venv .venv && source .venv/bin/activate -pip install -e . +pip install -e ".[dev]" ``` ## Basic usage diff --git a/docs/index.md b/docs/index.md index 4c88224..55ceb9a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -12,11 +12,18 @@ A **source** (`SpatialSource`) goes through a **derivation** that applies an **o ## Quick install +```bash +pip install disscube # from PyPI +pip install "disscube[dissmodel]" # + hand-off of the cube to DisSModel models +``` + +From a clone, for development: + ```bash git clone https://github.com/DisSModel/disscube.git cd disscube python -m venv .venv && source .venv/bin/activate -pip install -e . +pip install -e ".[dev]" ``` ## Main workflow