From ede8d84788f280744aeecbed27ee35255fab1b84 Mon Sep 17 00:00:00 2001 From: Joe Ranalli Date: Thu, 7 Nov 2024 14:01:09 -0500 Subject: [PATCH] Update changelog and readme --- Changelog.md | 6 +++++- README.md | 4 ++++ docs/sphinx/source/conf.py | 10 +++++++--- setup.cfg | 2 +- 4 files changed, 17 insertions(+), 5 deletions(-) diff --git a/Changelog.md b/Changelog.md index 8bb853c..a6dada0 100644 --- a/Changelog.md +++ b/Changelog.md @@ -73,4 +73,8 @@ site itself. # Version 0.5.0 - Sept 15, 2024 - Updating dependencies and test targets - Fix deprecation warnings raised by numpy -- JOSS publication \ No newline at end of file +- JOSS publication +# Version 0.5.1 - Nov 7, 2024 +- Create `synthirrad` package +- Implement the `synthirrad.cloudfield` module +- Tests and demos for the new package \ No newline at end of file diff --git a/README.md b/README.md index 8644462..6031a5e 100644 --- a/README.md +++ b/README.md @@ -65,6 +65,10 @@ might be useful for these analyses. Right now this only contains a function for decorating the frequency axis of plots with common timescales. This is an area that could use some expansion in the future. +```synthirrad``` +Tools for generating synthetic irradiance timeseries and performing downscaling +operations on time series data. + ```demos``` Data and demonstration codes (including as jupyter notebooks) that demonstrate the functionality of the package. An explanation for the included data is diff --git a/docs/sphinx/source/conf.py b/docs/sphinx/source/conf.py index b58b01b..0268c87 100644 --- a/docs/sphinx/source/conf.py +++ b/docs/sphinx/source/conf.py @@ -10,13 +10,17 @@ copyright = '2024, Joe Ranalli' author = 'Joe Ranalli' -release = '0.4' -version = '0.4.5' - import os import sys +import configparser sys.path.insert(0, os.path.abspath(os.path.join('..', '..', '..', 'src'))) +config_fn = os.path.abspath(os.path.join('..', '..', '..', 'setup.cfg')) +parser = configparser.RawConfigParser() +parser.read(config_fn) +version = parser.get('metadata', 'version') +release = version + # -- General configuration --------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration diff --git a/setup.cfg b/setup.cfg index befffdc..06f6017 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,6 +1,6 @@ [metadata] name = solarspatialtools -version = 0.5.0 +version = 0.5.1 author = 'Joe Ranalli' author_email = jar339@psu.edu description = A package for spatial analysis of solar energy and solar irradiance