Merge pull request #28 from VirtualPlanetaryLaboratory/v3.0

Updated workflows and README
VirtualPlanetaryLaboratory · Aug 25, 2023 · 18c782c · 18c782c
2 parents 4834206 + 5e34574
commit 18c782c
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 16 deletions.
diff --git a/.github/workflows/wheels.yml → .github/workflows/pip-install.yml b/.github/workflows/wheels.yml → .github/workflows/pip-install.yml
@@ -1,4 +1,4 @@
-name: wheels
+name: pip-install
 
 on:
   release:
@@ -7,18 +7,23 @@ on:
 
 jobs:
 
-  build:
-    name: Build source distribution
-    runs-on: ubuntu-latest
+  build: 
+    name: ${{ matrix.os }}:${{ matrix.python }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        python: ['3.7', '3.8', '3.9']
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
         with:
+          submodules: true
           fetch-depth: 0
 
-      - uses: actions/setup-python@v2
+      - uses: actions/setup-python@v4
         name: Install Python
         with:
-          python-version: "3.8"
+          python-version: ${{ matrix.python }}
 
       - name: Build
         run: |
@@ -37,7 +42,7 @@ jobs:
           venv-wheel/bin/python -m pip install dist/bigplanet*.whl
           venv-wheel/bin/python -c "import bigplanet; print(bigplanet.__version__)"
 
-      - uses: actions/upload-artifact@v2
+      - uses: actions/upload-artifact@v3
         with:
           path: dist/*
 
@@ -46,7 +51,7 @@ jobs:
     runs-on: ubuntu-latest
     if: github.event_name == 'release' && github.event.action == 'published'
     steps:
-      - uses: actions/download-artifact@v2
+      - uses: actions/download-artifact@v3
         with:
           name: artifact
           path: dist

diff --git a/README.md b/README.md
@@ -5,16 +5,26 @@
 <h1 align="center">BigPlanet: Big Data with VPLanet</h1>
 
 <p align="center">
-  <a href="https://VirtualPlanetaryLaboratory.github.io/bigplanet/"><img src="https://img.shields.io/badge/read-the_docs-blue.svg?style=flat"></a>
+  <a href="https://VirtualPlanetaryLaboratory.github.io/bigplanet/">
+    <img src="https://img.shields.io/badge/read-the_docs-blue.svg?style=flat">
+  </a>
   <a href="https://github.com/VirtualPlanetaryLaboratory/bigplanet/actions/workflows/docs.yml">
-  <img src="https://github.com/VirtualPlanetaryLaboratory/bigplanet/actions/workflows/docs.yml/badge.svg">
-    <img src="https://img.shields.io/badge/Python-3.6--3.9-orange.svg"></a>
+    <img src="https://github.com/VirtualPlanetaryLaboratory/bigplanet/actions/workflows/docs.yml/badge.svg">
+  </a> 
   <a href="LICENSE"><img src="https://img.shields.io/badge/license-MIT-purple.svg"></a>
-    <a href="https://github.com/VirtualPlanetaryLaboratory/bigplanet/actions/workflows/tests.yml">
-  <img src="https://github.com/VirtualPlanetaryLaboratory/bigplanet/actions/workflows/tests.yml/badge.svg">
-<a href="https://github.com/VirtualPlanetaryLaboratory/bigplanet/actions/workflows/wheels.yml">
-  <img src="https://github.com/VirtualPlanetaryLaboratory/bigplanet/actions/workflows/wheels.yml/badge.svg">
+  <a href="https://VirtualPlanetaryLaboratory.github.io/vplanet/conduct.html">
+    <img src="https://img.shields.io/badge/Code%20of-Conduct-7d93c7.svg">
+  </a>
+  <br>
+  <img src="https://img.shields.io/badge/Unit%20Tests-5-darkblue.svg">
+  <a href="https://github.com/VirtualPlanetaryLaboratory/bigplanet/actions/workflows/tests.yml">
+    <img src="https://github.com/VirtualPlanetaryLaboratory/bigplanet/actions/workflows/tests.yml/badge.svg">
+  </a>
+  <a href="https://github.com/VirtualPlanetaryLaboratory/bigplanet/actions/workflows/pip-install.yml">
+    <img src="https://github.com/VirtualPlanetaryLaboratory/bigplanet/actions/workflows/pip-install.yml/badge.svg">
   </a>
+  <img src="https://img.shields.io/badge/Python-3.6--3.9-orange.svg">
+  <img src = "https://img.shields.io/badge/Platforms-Linux_|%20macOS-darkgreen.svg?style=flat">
 </p>
 
 A suite of data analysis and extraction routines for [VPLanet](https://github.com/VirtualPlanetaryLaboratory/vplanet) and designed to be used with [VSPACE](https://github.com/VirtualPlanetaryLaboratory/vspace) and [MultiPlanet](https://github.com/VirtualPlanetaryLaboratory/multi-planet) scripts. It can also generate files for use with the free version of the [VR Ulysses data explorer](https://www.vrulysses.com/download-ulysses). [Read the docs](https://VirtualPlanetaryLaboratory.github.io/bigplanet/) to learn how to get the most out of your VPLanet parameter sweeps.