Skip to content

Commit

Permalink
REL: 0.1.0 (#91)
Browse files Browse the repository at this point in the history
* REL: 0.1.0, document moving to beta status, update CI, CITATION.cff, README.md
Co-authored-by: Max Grover <[email protected]>
  • Loading branch information
kmuehlbauer authored Feb 23, 2023
1 parent 4f59a8e commit 4b956af
Show file tree
Hide file tree
Showing 6 changed files with 41 additions and 21 deletions.
37 changes: 23 additions & 14 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,9 @@ jobs:
name: codecov-gha
fail_ci_if_error: false

test_build_distribution:
name: test build distribution
test_build_distribution_testpypi:
name: test build distribution for testpypi
needs: [lint, build_0]
runs-on: ubuntu-latest
defaults:
run:
Expand All @@ -95,19 +96,29 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install build setuptools wheel
pip install build setuptools wheel twine toml-cli
- name: Package
run: |
toml set --toml-path pyproject.toml tool.setuptools_scm.local_scheme "no-local-version"
git update-index --assume-unchanged pyproject.toml
python -m build
cp dist/xradar*.gz dist/xradar0.gz
cp dist/xradar*.gz dist/xradar1.gz
- name: Upload artifact
uses: actions/upload-artifact@v3
with:
name: xradar-0-${{github.event.number}}
path: dist/xradar0.gz
name: xradar-1-${{github.event.number}}
path: dist/xradar1.gz
- name: Upload to TestPyPI
if: ${{ github.event_name == 'push' }}
env:
TWINE_USERNAME: __token__
TWINE_PASSWORD: ${{ secrets.TESTPYPI_API_TOKEN }}
run: |
twine upload --repository testpypi dist/*
test_build_distribution2:
name: test build distribution for testpypi
test_build_distribution_pypi:
name: test build distribution
needs: [lint, build_0, test_build_distribution_testpypi]
runs-on: ubuntu-latest
defaults:
run:
Expand All @@ -123,15 +134,13 @@ jobs:
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install build setuptools wheel twine toml-cli
pip install build setuptools wheel
- name: Package
run: |
toml set --toml-path pyproject.toml tool.setuptools_scm.local_scheme "no-local-version"
git update-index --assume-unchanged pyproject.toml
python -m build
cp dist/xradar*.gz dist/xradar1.gz
cp dist/xradar*.gz dist/xradar0.gz
- name: Upload artifact
uses: actions/upload-artifact@v3
with:
name: xradar-1-${{github.event.number}}
path: dist/xradar1.gz
name: xradar-0-${{github.event.number}}
path: dist/xradar0.gz
6 changes: 3 additions & 3 deletions .github/workflows/upload_pypi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ jobs:
run:
shell: bash -l {0}
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
with:
fetch-depth: 0
- name: Set up Python
uses: actions/setup-python@v2
uses: actions/setup-python@v4
with:
python-version: "3.10"
python-version: "3.11"
- name: Install dependencies
run: |
python -m pip install --upgrade pip
Expand Down
6 changes: 3 additions & 3 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
cff-version: 1.0.3
message: If you use this software, please cite it using these metadata.
# FIXME title as repository name might not be the best name, please make human readable
title: 'openradar/xradar: xradar v0.0.10'
title: 'openradar/xradar: xradar v0.1.0'
doi: 10.5281/zenodo.7091737
# FIXME splitting of full names is error prone, please check if given/family name are correct
authors:
Expand All @@ -15,7 +15,7 @@ authors:
family-names: Mühlbauer
affiliation: University Bonn
orcid: https://orcid.org/0000-0001-6599-1034
version: 0.0.13
date-released: 2023-02-09
version: 0.1.0
date-released: 2023-02-23
repository-code: https://github.com/openradar/xradar
license: MIT
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2022, Open Radar Community Developers
Copyright (c) 2022-2023, Open Radar Community Developers

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ As memory representation an xarray based data model was chosen, which is interna

Any software package that uses xarray in any way will then be able to directly use the described data model and thus quickly and easily import and export radar data. Another advantage is the easy connection to already existing [open source radar processing software](https://openradarscience.org/pages/projects/#).

## Status

Xradar is considered stable for the implemented readers and writers which have been ported from wradlib. It will remain in beta status until the standard is finalized and the API as well as data model will move into stable/production status.

## Features

* Import CfRadial1 data
Expand Down
7 changes: 7 additions & 0 deletions docs/history.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# History

## 0.1.0 (2023-02-23)

* Add an example on reading multiple sweeps into a single object ({pull}`69`) by [@mgrover1](https://github.com/mgrover1)
* ENH: add spatial_ref with pyproj when georeferencing, add/adapt methods/tests ({issue}`38`), ({pull}`87`) by [@kmuehlbauer](https://github.com/kmuehlbauer)
* Docs/docstring updates, PULL_REQUEST_TEMPLATE.md ({pull}`89`) by [@kmuehlbauer](https://github.com/kmuehlbauer)
* Finalize release 0.1.0, add testpypi upload on push to main ({pull}`91`) by [@kmuehlbauer](https://github.com/kmuehlbauer)

## 0.0.13 (2023-02-09)

* FIX: only skip setting cf-attributes if both gain and offset are unused ({pull}`85`) by [@kmuehlbauer](https://github.com/kmuehlbauer)
Expand Down

0 comments on commit 4b956af

Please sign in to comment.