From a4e7ae4a18c3aa56fe9169f0b945ffe708b901a8 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 16 Feb 2024 14:54:30 +0000 Subject: [PATCH 1/6] Create python-publish.yml --- .github/workflows/python-publish.yml | 39 ++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 .github/workflows/python-publish.yml diff --git a/.github/workflows/python-publish.yml b/.github/workflows/python-publish.yml new file mode 100644 index 0000000..bdaab28 --- /dev/null +++ b/.github/workflows/python-publish.yml @@ -0,0 +1,39 @@ +# This workflow will upload a Python Package using Twine when a release is created +# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries + +# This workflow uses actions that are not certified by GitHub. +# They are provided by a third-party and are governed by +# separate terms of service, privacy policy, and support +# documentation. + +name: Upload Python Package + +on: + release: + types: [published] + +permissions: + contents: read + +jobs: + deploy: + + runs-on: ubuntu-latest + + steps: + - uses: actions/checkout@v3 + - name: Set up Python + uses: actions/setup-python@v3 + with: + python-version: '3.x' + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install build + - name: Build package + run: python -m build + - name: Publish package + uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29 + with: + user: __token__ + password: ${{ secrets.PYPI_API_TOKEN }} From 9cb8362ab72122d1b52c96c54b2a3166f712b183 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 16 Feb 2024 15:04:10 +0000 Subject: [PATCH 2/6] Update README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 6898f5a..1e2ff0c 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,8 @@ A Python toolkit for calculating dose rates in Earth's atmosphere based on any incoming proton or alpha particle spectra, with any pitch angle distribution. +**If you use this software for scientific research, please reference AniMAIRE as C. S. W. Davis, F. Lei, F. Baird, K. Ryden and C. Dyer (2023). AniMAIRE version {version number}. https://github.com/ssc-maire/AniMAIRE-public , https://pypi.org/project/AniMAIRE/ . Surrey Space Center, University of Surrey.** + ## Installation To install this toolkit from this Github repository, first clone this repository to your local system, and then from the cloned respository, run From 65a6579b1f1c3640dd31f3c7816f35fb0ebe15ae Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 16 Feb 2024 15:08:33 +0000 Subject: [PATCH 3/6] Create dependabot.yml --- .github/dependabot.yml | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 .github/dependabot.yml diff --git a/.github/dependabot.yml b/.github/dependabot.yml new file mode 100644 index 0000000..9d866e3 --- /dev/null +++ b/.github/dependabot.yml @@ -0,0 +1,11 @@ +# To get started with Dependabot version updates, you'll need to specify which +# package ecosystems to update and where the package manifests are located. +# Please see the documentation for all configuration options: +# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file + +version: 2 +updates: + - package-ecosystem: "pip" # See documentation for possible values + directory: "/" # Location of package manifests + schedule: + interval: "weekly" From cc5ffc77ca0a98bf3a64e1edf81716c0cc3c9289 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Fri, 16 Feb 2024 15:16:44 +0000 Subject: [PATCH 4/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 1e2ff0c..b79be52 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ A Python toolkit for calculating dose rates in Earth's atmosphere based on any incoming proton or alpha particle spectra, with any pitch angle distribution. -**If you use this software for scientific research, please reference AniMAIRE as C. S. W. Davis, F. Lei, F. Baird, K. Ryden and C. Dyer (2023). AniMAIRE version {version number}. https://github.com/ssc-maire/AniMAIRE-public , https://pypi.org/project/AniMAIRE/ . Surrey Space Center, University of Surrey.** +If you use this software for scientific research, please reference AniMAIRE as **C. S. W. Davis, F. Lei, F. Baird, K. Ryden and C. Dyer (2023). AniMAIRE version {version number}. https://github.com/ssc-maire/AniMAIRE-public , https://pypi.org/project/AniMAIRE/ . Surrey Space Center, University of Surrey.** ## Installation From dda82650ab16de16fd88f601c1062b4f8bc547eb Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 22 Feb 2024 00:51:24 +0000 Subject: [PATCH 5/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b79be52..a507a81 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # AniMAIRE -**N.B. Currently this tool only runs on Linux-based machines (not on Windows)** +**N.B. Currently this tool only runs on Linux-based machines (not on Windows), and requires a copy of !(http://cosray.unibe.ch/~laurent/magnetocosmics/)[MAGNETOCOSMICS] to be installed.** A Python toolkit for calculating dose rates in Earth's atmosphere based on any incoming proton or alpha particle spectra, with any pitch angle distribution. From 1fef2df555fd723bfcb18b5297615973946dd9c9 Mon Sep 17 00:00:00 2001 From: Chris Davis Date: Thu, 22 Feb 2024 00:52:12 +0000 Subject: [PATCH 6/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a507a81..3529dc3 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # AniMAIRE -**N.B. Currently this tool only runs on Linux-based machines (not on Windows), and requires a copy of !(http://cosray.unibe.ch/~laurent/magnetocosmics/)[MAGNETOCOSMICS] to be installed.** +**N.B. Currently this tool only runs on Linux-based machines (not on Windows), and requires a copy of [MAGNETOCOSMICS](http://cosray.unibe.ch/~laurent/magnetocosmics/) to be installed.** A Python toolkit for calculating dose rates in Earth's atmosphere based on any incoming proton or alpha particle spectra, with any pitch angle distribution.