Skip to content

docs: install from PyPI (pip install disscube); PyPI and DOI #61

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
profsergiocosta merged 1 commit into from
Oct 8, 2026
Merged

docs: install from PyPI (pip install disscube); PyPI and DOI #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 10 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.**

Expand All @@ -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
Expand Down
9 changes: 8 additions & 1 deletion docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading