---
jupytext:
  text_representation:
    extension: .md
    format_name: myst
    format_version: 0.13
    jupytext_version: 1.16.4
---
# Quickstart

## Installation
```bash
pip install qubed
```

## Usage
Make an uncompressed qube:

```{code-cell} python3
from qubed import Qube

q = Qube.from_dict({
    "class=od" : {
        "expver=0001": {"param=1":{}, "param=2":{}},
        "expver=0002": {"param=1":{}, "param=2":{}},
    },
    "class=rd" : {
        "expver=0001": {"param=1":{}, "param=2":{}, "param=3":{}},
        "expver=0002": {"param=1":{}, "param=2":{}},
    },
})
print(f"{q.n_leaves = }, {q.n_nodes = }")
q
```

Compress it:

```{code-cell} python3
cq = q.compress()
assert cq.n_leaves == q.n_leaves
print(f"{cq.n_leaves = }, {cq.n_nodes = }")
cq
```

Load a larger example qube (requires source checkout):

```{code-cell} python3
import requests
qube_json = requests.get("https://github.com/ecmwf/qubed/raw/refs/heads/main/tests/example_qubes/climate_dt.json").json()
climate_dt = Qube.from_json(qube_json)

# Using the html or print methods is optional but lets you specify things like the depth of the tree to display.
print(f"{climate_dt.n_leaves = }, {climate_dt.n_nodes = }")
climate_dt.html(depth=1) # Limit how much is open initially, click leave to see more.
```

Select a subset of the tree:

```{code-cell} python3
climate_dt.select({
    "activity": "scenariomip"
}).html(depth=1)
```

Use `.span("key")` to get the set of possibles values for a key, note this includes anywhere this key appears in the tree.

```{code-cell} python3
climate_dt.span("activity")
```

Use `.axes()` to get the span of every key in one go.

```{code-cell} python3
axes = climate_dt.axes()
for key, values in axes.items():
    print(f"{key} : {list(values)[:10]}")
```


<!-- ### Set Operations

```{code-cell} python3
A = Qube.from_dict({
    "a=1/2/3" : {"b=1/2/3" : {"c=1/2/3" : {}}},
    "a=5" : {  "b=4" : {  "c=4" : {}}}
    })

B = Qube.from_dict({
    "a=1/2/3" : {"b=1/2/3" : {"c=1/2/3" : {}}},
    "a=5" : {  "b=4" : {  "c=4" : {}}}
    })

A.print(name="A"), B.print(name="B");

A | B
``` -->

<!-- ### Command Line Usage

```bash 
fdb list class=rd,expver=0001,... | qubed --from=fdblist --to=text
```

`--from` options include: 
* `fdblist`
* `json`
* `protobuf`
* `marslist`
* `constraints`

`--to` options include:
* `text`
* `html`
* `json`
* `datacubes`
* `constraints`

use `--input` and `--output` to specify input and output files respectively. -->