diff --git a/.bumpversion.cfg b/.bumpversion.cfg index 5f946fa34..643d59217 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,5 +1,5 @@ [bumpversion] -current_version = 0.21.5 +current_version = 1.0.0 [bumpversion:file:VERSION] diff --git a/CITATION.cff b/CITATION.cff index 1f8203b18..027af6ded 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -28,7 +28,7 @@ authors: title: "Open Energy Family - Open Energy Platform (OEP)" type: software license: AGPL-3.0-or-later -version: 0.21.5 +version: 1.0.0 doi: -date-released: 2024-08-19 +date-released: 2024-09-23 url: "https://github.com/OpenEnergyPlatform/oeplatform/" diff --git a/RELEASE_PROCEDURE.md b/RELEASE_PROCEDURE.md index 71c2e0669..17e8c48fb 100644 --- a/RELEASE_PROCEDURE.md +++ b/RELEASE_PROCEDURE.md @@ -35,7 +35,7 @@ Before see How to [Contribute](https://github.com/OpenEnergyPlatform/oeplatform/ ![git branching model](https://nvie.com/img/git-model@2x.png) 1. Merge all feature and hotfix branches into `develop` -1. Starting out in the `develop` branch, make a release candidate branch (e.g., `release/vx.x.x`) +1. Starting out in the `develop` branch, make a release candidate branch (e.g., `release-vx.x.x`) 1. Update the oeplatform/versions/changelogs/ [`current.md`](https://github.com/OpenEnergyPlatform/oeplatform/blob/develop/versions/changelogs/current.md) (see the examples of previous releases) - Change filename to release version (x_x_x.md) - Copy template to `current.md` diff --git a/VERSION b/VERSION index e756a90e6..3eefcb9dd 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -0.21.5 +1.0.0 diff --git a/oeplatform/__init__.py b/oeplatform/__init__.py index d07586a90..5becc17c0 100644 --- a/oeplatform/__init__.py +++ b/oeplatform/__init__.py @@ -1 +1 @@ -__version__ = "0.21.5" +__version__ = "1.0.0" diff --git a/versions/changelogs/1_0_0.md b/versions/changelogs/1_0_0.md new file mode 100644 index 000000000..d6ea633e0 --- /dev/null +++ b/versions/changelogs/1_0_0.md @@ -0,0 +1,47 @@ +# Changes to the oeplatform code + +## Changes + +- Enhance embargo area feature (UI & API) [(#1804)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1804) + + - Refactor code + - The REST API raises an error when creating a table with embargo period but false date time for start/end data + - Update the table creation http "put" endpoint to handle embargo periods + +- Enhances UX by adding a site heading and improve visibility of form controls in the oemetaBuilder tool. [(#1680)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1680) + +- Enhance the ontology pages, remove the modules page and fully rework the about page and oeo download capabilities. Additionally add the oeox and make its URIs available, also add more cases where a Http404 is raised to make [(#1807)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1807) + +- Update the OpenEnergyFamily group picture on the about page [(#1816)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1816) + +- Update existing ontology layout [(#1850)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1850) + +- Add the Early access indicator to oeox plugin view buttons & The oeox owl file is now stored in the media directory to avoid writing to insecure directory. [(#1857)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1857) + +- Add the page header bar (name of feature and on page navigation below nav bar) to data upload wizard & oeo-viewer pages including links to external sources and academy tutorials [(#1860)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1860). + +- Remove "Create Table" card from wizard feature if the table exists and the user want to upload CSV data. (Note: Later on it should be possible to edit the table structure and possibly rename the table) [(#1860)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1860). + +- Enhance the OEP-about page content and layout [(#1859)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1859). + +## Features + +- Add the OEP-extended (oeo-ext) feature. It enables users to create new composed units (ontology classes) that extent the units available in the OEO. The feature is implemented as a plugin html form, it can be easily added to any Webpage of the oeplatform. [(#1680)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1680) + +- Add error message display to oeox-plugin view. [(#1812)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1812) + +- Add the quantitative scenario projection comparison feature that enable users to compare datasets that are part of a scenario bundles scenario definition with datasets from other scenario bundles if they have the same scenario. This implements the same-same comparison style where scenario can be compared that share the same characteristics. We described the various comparison styles in the typology paper on [zenodo](https://zenodo.org/records/7456286). This feature extends the scenario bundles and is still an early access research prototype implemented for demonstration purposes. [(#1766)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1766) + +## Bugs + +- Added missing setting for Authorization of users in API requests [(#1830)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1830) + +- Added check to ensure table name is valid before creation in API [(#1834)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1834) + +## Documentation updates + +- Improved OpenAPI documentation of oeplatform REST-API [(#1793)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1793) + +- Updated documentation for docker to include how to restart oeplatform [(#1830)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1830) + +- Enhance installation instruction with information on how to setup the OEO-extended feature [(#1857)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1857). diff --git a/versions/changelogs/current.md b/versions/changelogs/current.md index d6ea633e0..339c31ecd 100644 --- a/versions/changelogs/current.md +++ b/versions/changelogs/current.md @@ -2,46 +2,8 @@ ## Changes -- Enhance embargo area feature (UI & API) [(#1804)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1804) - - - Refactor code - - The REST API raises an error when creating a table with embargo period but false date time for start/end data - - Update the table creation http "put" endpoint to handle embargo periods - -- Enhances UX by adding a site heading and improve visibility of form controls in the oemetaBuilder tool. [(#1680)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1680) - -- Enhance the ontology pages, remove the modules page and fully rework the about page and oeo download capabilities. Additionally add the oeox and make its URIs available, also add more cases where a Http404 is raised to make [(#1807)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1807) - -- Update the OpenEnergyFamily group picture on the about page [(#1816)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1816) - -- Update existing ontology layout [(#1850)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1850) - -- Add the Early access indicator to oeox plugin view buttons & The oeox owl file is now stored in the media directory to avoid writing to insecure directory. [(#1857)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1857) - -- Add the page header bar (name of feature and on page navigation below nav bar) to data upload wizard & oeo-viewer pages including links to external sources and academy tutorials [(#1860)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1860). - -- Remove "Create Table" card from wizard feature if the table exists and the user want to upload CSV data. (Note: Later on it should be possible to edit the table structure and possibly rename the table) [(#1860)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1860). - -- Enhance the OEP-about page content and layout [(#1859)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1859). - ## Features -- Add the OEP-extended (oeo-ext) feature. It enables users to create new composed units (ontology classes) that extent the units available in the OEO. The feature is implemented as a plugin html form, it can be easily added to any Webpage of the oeplatform. [(#1680)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1680) - -- Add error message display to oeox-plugin view. [(#1812)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1812) - -- Add the quantitative scenario projection comparison feature that enable users to compare datasets that are part of a scenario bundles scenario definition with datasets from other scenario bundles if they have the same scenario. This implements the same-same comparison style where scenario can be compared that share the same characteristics. We described the various comparison styles in the typology paper on [zenodo](https://zenodo.org/records/7456286). This feature extends the scenario bundles and is still an early access research prototype implemented for demonstration purposes. [(#1766)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1766) - ## Bugs -- Added missing setting for Authorization of users in API requests [(#1830)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1830) - -- Added check to ensure table name is valid before creation in API [(#1834)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1834) - ## Documentation updates - -- Improved OpenAPI documentation of oeplatform REST-API [(#1793)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1793) - -- Updated documentation for docker to include how to restart oeplatform [(#1830)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1830) - -- Enhance installation instruction with information on how to setup the OEO-extended feature [(#1857)](https://github.com/OpenEnergyPlatform/oeplatform/pull/1857).