Finalising for 0.1 release (#30)

* Bump version to 0.1.0 ready for release

* Small fix for older matplotlib versions

* Update package metadata and README

* Add docstrings for from_vires andfrom_hapi

* Fix formatting

* More tweaks for docs

* Allow numpy 1.21

Author: smithara

CITATION.cff

@@ -17,6 +17,7 @@ authors:
     orcid: 'https://orcid.org/0000-0001-7212-5791'
   - given-names: Theresa
     family-names: Hoppe
+    orcid: 'https://orcid.org/0009-0000-7108-5468'
   - given-names: Heikki
     family-names: Vanhamäki
     orcid: 'https://orcid.org/0000-0002-3454-0350'

README.md

@@ -1,8 +1,13 @@
 # SwarmPAL
 
 ---
+[![Swarm-VRE](https://img.shields.io/badge/%F0%9F%9A%80%20launch-Swarm--VRE-blue)](https://vre.vires.services/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2Fsmithara%2Fswarmpal-demo&urlpath=lab%2Ftree%2Fswarmpal-demo%2FREADME.ipynb&branch=main)
+[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/smithara/swarmpal-demo/HEAD)
+
+[![PyPI](https://img.shields.io/pypi/v/swarmpal)]( https://pypi.org/project/swarmpal/)
 [![Documentation](https://img.shields.io/badge/docs-online-success)][rtd-link]
 [![GitHub Discussion][github-discussions-badge]][github-discussions-link]
+
 [![Actions Status][actions-badge]][actions-link]
 [![Code style: black][black-badge]][black-link]
 [![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
@@ -25,4 +30,7 @@
 [rtd-badge]:                https://img.shields.io/badge/docs-online-success
 [rtd-link]:                 https://swarmpal.readthedocs.io/
 
-See the [SwarmPAL development guide on HackMD](https://hackmd.io/@swarm/dev/%2Ff6YIHfqxT9yL0giWJzhr_Q)
+![SwarmPAL diagram](https://swarmpal-benchmarks.netlify.app/swarmpal-diagram.png)
+
+For more information see:
+- <https://swarmdisc.org/lab/>

docs/acknowledgements.md

@@ -3,7 +3,7 @@
 If you make use of this package in a publication, please cite the following:
 
 ```raw
-[Pending Zenodo link and update of https://github.com/Swarm-DISC/SwarmPAL/blob/main/CITATION.cff]
+[Pending Zenodo link - for now, just reference the GitHub repo]
 ```
 
 ## Funding

docs/changelog.md

@@ -1,6 +1,6 @@
 # Changelog
 
-## 0.1
+## 0.1 (2023-04-13)
 
 - First release ✨
 - Reasonable implementation of using `DataTree` and `PalProcess` base class

docs/conf.py

@@ -80,7 +80,10 @@
     "use_repository_button": True,
     "use_issues_button": True,
     "use_edit_page_button": True,
-    "announcement": "WARNING! THIS PACKAGE IS IN ACTIVE DEVELOPMENT AND IS NOT YET STABLE!",
+    "announcement": (
+        "WARNING! THIS PACKAGE IS IN ACTIVE DEVELOPMENT AND IS NOT YET STABLE!<br>"
+        "<button><a href='https://vre.vires.services/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2Fsmithara%2Fswarmpal-demo&amp;urlpath=lab%2Ftree%2Fswarmpal-demo%2FREADME.ipynb&amp;branch=main'>Click here to try SwarmPAL in the Virtual Research Environment</a></button>"
+    ),
 }
 
 # Add any paths that contain custom static files (such as style sheets) here,

docs/contributing.md

@@ -6,6 +6,7 @@
 1. Join the mailing list at <https://groups.io/g/swarm-dev>
 1. Join a meeting at <https://hackmd.io/@swarm/meetings>
 1. Found something to improve? [Open an Issue on GitHub](https://github.com/Swarm-DISC/SwarmPAL/issues) or get in touch otherwise
+1. Have other ideas / requests for help? [Start a Discussion on GitHub](https://github.com/Swarm-DISC/SwarmPAL/discussions)
 
 ## Development
 

docs/installation.md

@@ -1,18 +1,16 @@
 # Installation
 
-## ESA Virtual Research Environment
+## Swarm Virtual Research Environment
 
-> To be updated
+The easiest way to use SwarmPAL is in the Swarm Virtual Research Environment (read more [here](https://notebooks.vires.services/)). To get started with the SwarmPAL demo tool (which includes the examples given on these pages, as interactive notebooks), follow this link: [![Swarm-VRE](https://img.shields.io/badge/%F0%9F%9A%80%20launch-Swarm--VRE-blue)](https://vre.vires.services/hub/user-redirect/git-pull?repo=https%3A%2F%2Fgithub.com%2Fsmithara%2Fswarmpal-demo&urlpath=lab%2Ftree%2Fswarmpal-demo%2FREADME.ipynb&branch=main)
 
 ## Install latest release
 
-> To be updated
-
-<!-- The package is available from PyPI:
+The package is available from PyPI:
 
 ```bash
 pip install swarmpal
-``` -->
+```
 
 :::{admonition} New to Python?
 :class: note

pyproject.toml

@@ -6,10 +6,10 @@ build-backend = "flit_core.buildapi"
 [project]
 name = "swarmpal"
 authors = [
-    { name = "Ashley Smith", email = "ashley.smith@magneticearth.org" },
+    { name = "Ashley Smith", email = "ashley.smith@ed.ac.uk" },
 ]
 maintainers = [
-    { name = "Ashley Smith", email = "ashley.smith@magneticearth.org" },
+    { name = "Ashley Smith", email = "ashley.smith@ed.ac.uk" },
 ]
 license = { file = "LICENSE" }
 
@@ -30,14 +30,14 @@ classifiers = [
     "Programming Language :: Python :: 3.8",
     "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
-    "Development Status :: 1 - Planning",
+    "Development Status :: 4 - Beta",
 ]
 
 dynamic = ["version"]
 
 dependencies = [
     "hapiclient >= 0.2.3",
-    "numpy >= 1.22",
+    "numpy >= 1.21",
     "matplotlib >= 3.5",
     "scipy >= 1.8",
     "viresclient >= 0.11",

src/swarmpal/__init__.py

@@ -1,5 +1,5 @@
 from swarmpal import io, toolboxes
 
-__version__ = "0.1.0-a4"
+__version__ = "0.1.0"
 
 __all__ = ("__version__", "io", "toolboxes")

src/swarmpal/io/_paldata.py

@@ -191,7 +191,21 @@ def _pad_times(params: dict) -> tuple[dict, tuple[datetime]]:
     def from_vires(**params) -> PalDataItem:
         """Create PalDataItem from VirES source
 
-        TODO: Detail params given by swarmpal.io.datafetchers.ViresParameters
+        Parameters
+        ----------
+        collection : str
+        measurements : list[str]
+        start_time : str | datetime
+        end_time : str | datetime
+        models : list[str]
+        auxiliaries : list[str]
+        sampling_step : str
+        filters : list[str]
+        options : dict
+        server_url : str
+            defaults to "https://vires.services/ows"
+        pad_times : tuple[timedelta]
+            This is handled specially by SwarmPAL and not passed to viresclient
         """
         params, analysis_window = PalDataItem._pad_times(params)
         fetcher = get_fetcher("vires")(**params)
@@ -204,7 +218,16 @@ def from_vires(**params) -> PalDataItem:
     def from_hapi(**params) -> PalDataItem:
         """Create PalDataItem from HAPI source
 
-        TODO: Detail params given by swarmpal.io.datafetchers.HapiParameters
+        Parameters
+        ----------
+        server : str
+        dataset : str
+        parameters : str
+        start : str
+        stop : str
+        options : dict
+        pad_times : tuple[timedelta]
+            This is handled specially by SwarmPAL and not passed to hapiclient
         """
         params, analysis_window = PalDataItem._pad_times(params)
         fetcher = get_fetcher("hapi")(**params)