Skip to content

Commit fae7f88

Browse files
committed
prepare initial release
1 parent 6dbbef6 commit fae7f88

File tree

3 files changed

+46
-2
lines changed

3 files changed

+46
-2
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,13 @@ Base ArviZ features and converters (once finished).
99

1010
We are currently working on splitting ArviZ into independent modules.
1111
See https://github.com/arviz-devs/arviz/issues/2088 for more details.
12+
13+
---
14+
15+
A pre-release is already available on PyPI, install it with:
16+
17+
```
18+
pip install arviz-base
19+
```
20+
21+
More about ArviZ base at https://arviz-base.readthedocs.io

docs/source/index.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,34 @@
11
# arviz-base
22
ArviZ base features and converters.
33

4+
:::{important}
5+
This package is still in a very early development stage.
6+
Testing and feedback are extremely welcome, but for
7+
general applications, the main
8+
[ArviZ Python library](https://python.arviz.org)
9+
should be used.
10+
:::
11+
412
## Installation
513

6-
It currenly can only be installed with pip and from GitHub:
14+
It currently can only be installed with pip:
15+
16+
::::{tab-set}
17+
:::{tab-item} PyPI
18+
:sync: stable
19+
20+
```bash
21+
pip install arviz-base
22+
```
23+
:::
24+
:::{tab-item} GitHub
25+
:sync: dev
726

827
```bash
928
pip install arviz-base @ git+https://github.com/arviz-devs/arviz-base
1029
```
30+
:::
31+
::::
1132

1233
Note that `arviz-base` is a minimal package, which only depends on
1334
xarray (and xarray-datatree which will at some point be merged into xarray),
@@ -19,9 +40,22 @@ only plan to use zarr, there is no need to install netcdf.
1940

2041
For convenience, some bundles are available to be installed with:
2142

43+
::::{tab-set}
44+
:::{tab-item} PyPI
45+
:sync: stable
46+
47+
```bash
48+
pip install "arviz-base[<option>]"
49+
```
50+
:::
51+
:::{tab-item} GitHub
52+
:sync: dev
53+
2254
```bash
2355
pip install "arviz-base[<option>] @ git+https://github.com/arviz-devs/arviz-base"
2456
```
57+
:::
58+
::::
2559

2660
where `<option>` can be one of:
2761

src/arviz_base/_version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
11
"""Base ArviZ version."""
2-
__version__ = "0.1"
2+
__version__ = "0.1.0"

0 commit comments

Comments
 (0)