diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index bcf0fe82..e2a496b9 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -50,7 +50,7 @@ jobs: strategy: fail-fast: false matrix: - python-version: ["3.10", "3.11", "3.12"] + python-version: ["3.10", "3.12", "3.13"] os: ["ubuntu-latest", "macos-latest", "windows-latest"] steps: diff --git a/CHANGELOG.md b/CHANGELOG.md index 47c40ce9..74bc0a66 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -20,7 +20,7 @@ By [Callan Gray](https://github.com/calgray). - {py:class}`astropy.time.TimeDelta` - {py:class}`astropy.coordinates.Angle` - {py:class}`astropy.coordinates.Longitude` - - {py:class}`astropy.coordinates.Latitude`\*\*\*\* + - {py:class}`astropy.coordinates.Latitude` - {py:class}`astropy.coordinates.Distance` - {py:class}`astropy.units.LogQuantity` diff --git a/README.md b/README.md index 6469c7f7..67a38d6b 100644 --- a/README.md +++ b/README.md @@ -3,12 +3,16 @@ [![CI](https://github.com/calgray/astropy-xarray/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/calgray/astropy-xarray/actions/workflows/ci.yml) [![code coverage](https://codecov.io/gh/calgray/astropy-xarray/branch/main/graph/badge.svg)](https://codecov.io/gh/calgray/astropy-xarray) [![docs](https://readthedocs.org/projects/astropy-xarray/badge/?version=latest)](https://astropy-xarray.readthedocs.io) +[![PyPI python versions](https://img.shields.io/pypi/pyversions/astropy-xarray.svg?style=flat&logo=python&logoColor=white)](https://pypi.python.org/pypi/astropy-xarray) [![PyPI version](https://img.shields.io/pypi/v/astropy-xarray.svg)](https://pypi.org/project/astropy-xarray) -[![codestyle](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black) [![conda-forge](https://img.shields.io/conda/vn/conda-forge/astropy-xarray)](https://github.com/conda-forge/astropy-xarray-feedstock) +[![code style](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/python/black) +[![license](https://img.shields.io/badge/license-Apache%20License%202.0-blue)](https://opensource.org/license/Apache-2.0) +[![code of conduct](https://img.shields.io/badge/code%20of%20conduct-contributor%20covenant%203.0-4baaaa.svg)](CODE_OF_CONDUCT.md) +

- +

Seamless interoperability between [astropy](https://www.astropy.org) and diff --git a/docs/conf.py b/docs/conf.py index 1fbc90a3..9fa1290f 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -68,12 +68,16 @@ # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. # -html_theme = "sphinx_rtd_theme" +html_theme = "furo" +html_theme_options = { + "light_logo": "astropy_xarray_logo.png", + "dark_logo": "astropy_xarray_logo_invert.png", +} # Add any paths that contain custom static files (such as style sheets) here, # relative to this directory. They are copied after the builtin static files, # so a file named "default.css" will overwrite the builtin "default.css". -# html_static_path = ["_static"] +html_static_path = ["img"] # -- Extension configuration ------------------------------------------------- diff --git a/docs/img/astropy_xarray_logo.png b/docs/img/astropy_xarray_logo.png new file mode 100644 index 00000000..adb016a6 Binary files /dev/null and b/docs/img/astropy_xarray_logo.png differ diff --git a/docs/img/astropy_xarray_logo.svg b/docs/img/astropy_xarray_logo.svg index 53a51d6a..3cf13e86 100644 --- a/docs/img/astropy_xarray_logo.svg +++ b/docs/img/astropy_xarray_logo.svg @@ -7,9 +7,12 @@ version="1.1" viewBox="0 0 669.99998 315.83" id="svg469" - sodipodi:docname="astropy-xarray-logo.svg" + sodipodi:docname="astropy_xarray_logo.svg" xml:space="preserve" inkscape:version="1.4.3 (0d15f75042, 2025-12-25)" + inkscape:export-filename="astropy_xarray_logo.png" + inkscape:export-xdpi="96" + inkscape:export-ydpi="96" xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape" xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd" xmlns:xlink="http://www.w3.org/1999/xlink" @@ -72,2782 +75,15 @@ inkscape:pageopacity="0.0" inkscape:pagecheckerboard="0" inkscape:deskcolor="#d1d1d1" - inkscape:zoom="1.2579829" - inkscape:cx="314.3922" - inkscape:cy="159.38214" - inkscape:window-width="1920" - inkscape:window-height="1128" + inkscape:zoom="1.47373" + inkscape:cx="285.6697" + inkscape:cy="69.55141" + inkscape:window-width="2048" + inkscape:window-height="1078" inkscape:window-x="0" inkscape:window-y="0" inkscape:window-maximized="1" - inkscape:current-layer="g11" />astropyxarrayxarray + sodipodi:nodetypes="cc" /> + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/img/astropy_xarray_logo_invert.png b/docs/img/astropy_xarray_logo_invert.png new file mode 100644 index 00000000..8a573914 Binary files /dev/null and b/docs/img/astropy_xarray_logo_invert.png differ diff --git a/docs/img/astropy_xarray_logo_invert.svg b/docs/img/astropy_xarray_logo_invert.svg new file mode 100644 index 00000000..97b954d7 --- /dev/null +++ b/docs/img/astropy_xarray_logo_invert.svg @@ -0,0 +1,255 @@ + + + +astropyxarray + + + + + + + + + + + + + + + + + + + + + + + diff --git a/docs/index.md b/docs/index.md index 3ce23ea9..6d7ad52c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,20 +1,25 @@ # astropy-xarray -Seamless interoperability between [astropy] and [xarray]. +```{image} img/astropy_xarray_logo.png +:align: center +:width: 50% +:class: only-light +``` -```{image} img/astropy_xarray_logo.svg +```{image} img/astropy_xarray_logo_invert.png :align: center :width: 50% +:class: only-dark ``` ---- +Seamless interoperability between [astropy] and [xarray]. # Documentation -:::{warning} +```{warning} This package is experimental, and new versions might introduce backwards incompatible changes. -::: +``` ```{toctree} :caption: Getting Started @@ -38,7 +43,7 @@ terminology :caption: API Reference :maxdepth: 2 -api +python_api ``` ```{toctree} diff --git a/docs/installation.md b/docs/installation.md index 3ec6ff47..8006fc5d 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,12 +1,14 @@ # Installation + -or from `PyPI`: +Install from `PyPI`: ```sh python -m pip install astropy-xarray diff --git a/docs/api.md b/docs/python_api.md similarity index 90% rename from docs/api.md rename to docs/python_api.md index 5e78b99b..2973c182 100644 --- a/docs/api.md +++ b/docs/python_api.md @@ -4,14 +4,6 @@ This page contains a auto-generated summary of `astropy-xarray`'s API. ## Dataset -```{eval-rst} -.. autosummary:: - :toctree: generated/ - :template: autosummary/accessor_attribute.rst - - xarray.Dataset.astropy.loc -``` - ```{eval-rst} .. autosummary:: :toctree: generated/ @@ -74,7 +66,10 @@ This page contains a auto-generated summary of `astropy-xarray`'s API. .. autosummary:: :toctree: generated/ - astropy_xarray.coordinates + astropy_xarray.coordinates.dataset_to_skycoord + astropy_xarray.coordinates.skycoord_to_dataset + astropy_xarray.coordinates.load_frame + astropy_xarray.coordinates.load_representation ``` ## Testing diff --git a/docs/requirements.txt b/docs/requirements.txt index b2d0f5e5..b46659b9 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -6,7 +6,7 @@ netCDF4 msgpack-numpy>=0.4.8 cf-xarray>=0.6 sphinx>=8.0.0,<9.0.0 -sphinx_rtd_theme>=1.0 +furo ipython ipykernel jupyter_client diff --git a/pyproject.toml b/pyproject.toml index 1c019604..10816ed3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -9,18 +9,18 @@ authors = [ { name = "Tom Nicholas", email = "tomnicholas1@googlemail.com" }, ] description = "Physical units interface to xarray using astropy" -license = { text = "Apache-2" } +license = "Apache-2.0" readme = "README.md" classifiers = [ "Development Status :: 3 - Alpha", "Environment :: Console", "Intended Audience :: Science/Research", - "License :: OSI Approved :: Apache Software License", "Operating System :: OS Independent", "Programming Language :: Python", "Programming Language :: Python :: 3.10", "Programming Language :: Python :: 3.11", "Programming Language :: Python :: 3.12", + "Programming Language :: Python :: 3.13", "Topic :: Scientific/Engineering", ] requires-python = ">=3.10" @@ -52,7 +52,7 @@ docs = [ "sphinx==8.2.3", "myst-nb==1.4.0", "nbsphinx", - "sphinx-rtd-theme", + "furo", "sphinx-autosummary-accessors", ]