Prep release (#211)

CHANGELOG.md

@@ -7,6 +7,26 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.2.0] - 2024-02-02
+
+### Added
+
+- User guide
+- Download data through Appeears
+- Dockerfile
+
+### Changed
+
+- More standardization of data classes
+- R scripts run through command line call, no longer direct dependencies
+- Simplified license
+- Updated structure of documentation
+
+### Removed
+
+- Direct R calls through Rpy2
+- Executing models no longer part of workflow / package
+
 ## [0.1.0] - 2023-03-05
 
 ### Added
@@ -17,5 +37,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Documentation
 - License information
 
-[Unreleased]: https://github.com/phenology/springtime/compare/v0.1.0...HEAD
-[0.1.0]: [0.1.0]: https://github.com/phenology/springtime/releases/tag/v0.1.0
+[Unreleased]: https://github.com/phenology/springtime/compare/v0.2.0...HEAD
+[0.2.0]: https://github.com/phenology/springtime/compare/v0.1.0...v0.2.0
+[0.1.0]: https://github.com/phenology/springtime/releases/tag/v0.1.0

README.md

@@ -8,18 +8,27 @@ For detailed information and instruction, please refer to the
 <!--intro-start-->
 # Springtime
 
-The Springtime Python package helps to streamline workflows for doing machine
-learning with phenological datasets.
+Springtime is both a project and a python packaged aimed at streamlining
+workflows for doing machine learning with phenological datasets.
 
 Phenology is the scientific discipline in which we study the lifecycle of plants
 and animals. A common objective is to develop (Machine Learning) models that can
 explain or predict the occurrence of phenological events, such as the blooming
 of plants. Since there is a variety of data sources and existing tools to
 retrieve and analyse phenology data, it is easy to get lost and disorganized.
 
-With Springtime, we aim to provide a more streamlined workflow for working with
-a variety of datasets and (ML) models. You can run Springtime as a command line
-tool in a terminal or use it as a Python library e.g. in a Jupyter notebook.
+At the heart of springtime is a data representation following the scikit-learn
+standard structure. The springtime python package implements (down)loaders for
+various datasets that are able to convert the data to this same structure. Data
+loading specifications can be exported to yaml recipes for easy sharing.
+
+The documentation has an extensive user guide that shows how each of the data
+loaders convert from the raw to the standardized data format. It also includes
+examples of using various (combinations of) models.
+
+The data structure proposed here is still not ideal, and should rather be seen
+as a first step in standardizing workflows in phenological modelling. We hope it
+will serve as a basis for discussion and further developments.
 
 ## Example task
 

pyproject.toml

@@ -2,6 +2,12 @@
 requires = ["hatchling", "hatch-requirements-txt"]
 build-backend = "hatchling.build"
 
+[tool.hatch.build.targets.sdist]
+only-include = ["src"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/springtime"]
+
 [project]
 name = "springtime"
 description = "Spatiotemporal phenology research with interpretable models"
@@ -34,6 +40,7 @@ dependencies = [
   "cftime",
   "pyyaml",
   "pandas",
+  "requests",
   "pydantic==2.*",
   "click",
   "geopandas",