Skip to content

Commit

Permalink
Update readme and github actions
Browse files Browse the repository at this point in the history
  • Loading branch information
dahlend committed Sep 26, 2024
1 parent a9b0101 commit 307b57c
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 11 deletions.
28 changes: 17 additions & 11 deletions .github/workflows/release-wheels.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,13 @@
name: Release-Wheels

on:
release:
types:
- published
push:
tags: 'v[0-9]+.[0-9]+.[0-9]+'
workflow_dispatch:

concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true
Expand All @@ -18,7 +23,7 @@ jobs:
# Ensure that a wheel builder finishes even if another fails
fail-fast: false
matrix:
python: [310, 311, 312]
python: [39, 310, 311, 312]
os: [windows-latest, ubuntu-latest, macos-latest]
include:
# Window 64 bit
Expand Down Expand Up @@ -68,20 +73,21 @@ jobs:
name: wheel-cp${{ matrix.python }}-${{ matrix.platform_id }}
path: ./wheelhouse/*.whl
publish-to-pypi:
name: Publish Python 🐍 distribution 📦 to PyPI
if: startsWith(github.ref, 'refs/tags/') # only publish to PyPI on tag pushes
name: Publish Kete to PyPI
needs:
- build_wheels
- build_wheels
runs-on: ubuntu-latest
environment:
name: pypi
url: https://pypi.org/p/kete
permissions:
id-token: write
- name: Download all the dists
uses: actions/download-artifact@v4
with:
name: wheel-cp*.whl
path: wheelhouse/
- name: Publish distribution 📦 to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
steps:
- name: Download all the dists
uses: actions/download-artifact@v4
with:
pattern: wheel-*
path: dist
merge-multiple: true
- name: Publish to PyPI
uses: pypa/gh-action-pypi-publish@release/v1
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,11 @@ MPC catalog at once, without having to do queries on specific objects. It has be
used to simulate over 10 years of survey time for the NEO Surveyor mission using 10
million main-belt and near-Earth asteroids.

[Documentation](https://caltech-ipac.github.io/kete/)
- [Examples](https://caltech-ipac.github.io/kete/auto_examples/index.html)
- [Tutorials](https://caltech-ipac.github.io/kete/tutorials/index.html)


https://github.com/user-attachments/assets/a48491d8-9c15-4659-9022-1767a3aa1e94

Here is a simulation of what the ZTF survey would observe during the entirety of 2023.
Expand All @@ -31,8 +36,18 @@ This took about 50 minutes on a desktop computer to compute, and about 40 minute
to generate the movie.




## Installation

Kete may be installed using pip:

``` bash
pip install kete
```

## Installation - From Source

If kete is built from source, the rust compiler must be installed. Installation
instructions may be found here:

Expand Down

0 comments on commit 307b57c

Please sign in to comment.