Skip to content

Commit

Permalink
Rename to xarray-sql. (#41)
Browse files Browse the repository at this point in the history
This is Qarray no longer! Now, it's Xarray-sql (correct capitalization
TBD). The name change is due to the fact that `Qarray` is too similar to
other packages in PyPi (i.e. `Xarray`) and is not allowed to be
published. https://pypi.org/help/#project-name This is OK in my book;
"Qarray" was not a perfect name, either.
  • Loading branch information
alxmrs committed Mar 10, 2024
1 parent 3e83c0e commit b67f8eb
Show file tree
Hide file tree
Showing 17 changed files with 21 additions and 21 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,10 @@ jobs:
with:
python-version: ${{ matrix.python-version }}
cache: 'pip'
- name: Install qarray
- name: Install xarray_sql
run: |
pip install -e .[test]
- uses: 'actions/checkout@v4'
- name: Run unit tests
run: |
pytest qarray
pytest xarray_sql
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ reading [Xarray's contributing guide](https://docs.xarray.dev/en/stable/contribu
or [Mamba](https://mamba.readthedocs.io/en/latest/)
is preferred.
1. Clone the repository (bonus: [via SSH](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account))
and `cd qarray` (the project root).
and `cd xarray_sql` (the project root).
1. Install dev dependencies via: `pip install -e ".[dev]`
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# qarray
# xarray-sql

_Query Xarray via SQL_
_Query Xarray with SQL_

[![ci](https://github.com/alxmrs/qarray/actions/workflows/ci.yml/badge.svg)](https://github.com/alxmrs/qarray/actions/workflows/ci.yml)
[![lint](https://github.com/alxmrs/qarray/actions/workflows/lint.yml/badge.svg)](https://github.com/alxmrs/qarray/actions/workflows/lint.yml)
[![ci](https://github.com/alxmrs/xarray-sql/actions/workflows/ci.yml/badge.svg)](https://github.com/alxmrs/xarray-sql/actions/workflows/ci.yml)
[![lint](https://github.com/alxmrs/xarray-sql/actions/workflows/lint.yml/badge.svg)](https://github.com/alxmrs/xarray-sql/actions/workflows/lint.yml)


## What is this?
Expand All @@ -12,7 +12,7 @@ This is an experiment to provide a SQL interface for raster data.

```python
import xarray as xr
import qarray as qr
import xarray_sql as qr

ds = xr.tutorial.open_dataset('air_temperature')

Expand Down Expand Up @@ -56,8 +56,8 @@ A few reasons:
This is a light-weight way to prove the value of the interface.

The larger goal is to explore the hypothesis that [Pangeo](https://pangeo.io/)
is a scientific database. Here, Qarray can be thought of as a missing DB front
end.
is a scientific database. Here, xarray-sql can be thought of as a missing DB
front end.

## How does it work?

Expand Down Expand Up @@ -99,7 +99,7 @@ a [virtual](https://fsspec.github.io/kerchunk/)
filesystem for parquet that would internally map to Zarr. Raster-backed virtual
parquet would open up integrations to numeroustools like dask, pyarrow, duckdb,
and BigQuery. More thoughts on this
in [#4](https://github.com/alxmrs/qarray/issues/4).
in [#4](https://github.com/alxmrs/xarray-sql/issues/4).

## Sponsors & Contributors

Expand Down
2 changes: 1 addition & 1 deletion perf_tests/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ So far, this includes statistical profiles via py-spy.

This will open a flame graph in the browser.

2. After tuning code in qarray, run another profile to generate a SVG.
2. After tuning code in xarray-sql, run another profile to generate a SVG.

3. Please commit the "after" profile SVG along with the performance improvements.

2 changes: 1 addition & 1 deletion perf_tests/compute_air.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env python3

import xarray as xr
import qarray as qr
import xarray_sql as qr

if __name__ == '__main__':
air = xr.tutorial.open_dataset('air_temperature')
Expand Down
2 changes: 1 addition & 1 deletion perf_tests/groupby_air.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env python3

import xarray as xr
import qarray as qr
import xarray_sql as qr
from dask_sql import Context


Expand Down
2 changes: 1 addition & 1 deletion perf_tests/groupby_air_full.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env python3

import xarray as xr
import qarray as qr
import xarray_sql as qr
from dask_sql import Context


Expand Down
2 changes: 1 addition & 1 deletion perf_tests/open_era5.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env python3

import xarray as xr
import qarray as qr
import xarray_sql as qr

# Requires authenticating with GCP
era5_ds = xr.open_zarr(
Expand Down
2 changes: 1 addition & 1 deletion perf_tests/sanity.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env python3

import xarray as xr
import qarray as qr
import xarray_sql as qr

if __name__ == '__main__':
air = xr.tutorial.open_dataset('air_temperature')
Expand Down
8 changes: 4 additions & 4 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[project]
name = "qarray"
name = "xarray_sql"
dynamic = ["version"]
description = "Querry Xarray with SQL."
readme = "README.md"
Expand Down Expand Up @@ -37,14 +37,14 @@ test = [
"gcsfs",
]
dev = [
"qarray[test]",
"xarray_sql[test]",
"pyink",
"py-spy"
]

[project.urls]
Homepage = "https://github.com/alxmrs/qarray"
Issues = "https://github.com/alxmrs/qarray/issues"
Homepage = "https://github.com/alxmrs/xarray-sql"
Issues = "https://github.com/alxmrs/xarray-sql/issues"

[build-system]
requires = ["setuptools>=64", "setuptools_scm>=8"]
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 comments on commit b67f8eb

Please sign in to comment.