Skip to content

Commit

Permalink
changes for release 1.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
laestrada committed Sep 22, 2021
1 parent 005286e commit b113e3c
Show file tree
Hide file tree
Showing 7 changed files with 24 additions and 15 deletions.
9 changes: 8 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,20 @@ All notable changes to GCPy will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).

## Unreleased

### Added
### Changed
## [1.1.0] - 2021-09-22
### Added

- Added date_time.py module to help manage datetime utility functions
- Added GLYC, HAC, and pFe to benchmark categories
- Added gcpy/budget_ox.py to compute Ox budgets from 1-yr benchmarks
- Added capability to use GCHP 13.1.0+ or legacy file names in benchmark scripts
- Added new methods dataset_reader and get_dataset_mean to util.py

### Changed
- Modified benchmarking scripts to use yaml config files.
- Modified dry-run scripts to use yaml config files.
- Updated benchmark/run_1yr_fullchem_benchmark.py to call the budget_ox.py for GCC vs GCC benchmark generation.
- NOTE: we are waiting to make sure that the GCHP benchmarks output wetdep fields before activating this feature for GCHP.
- Modified plotting methods in benchmark.py to compute the mean of datasets over the time dimension, if the "time_mean" keyword is passed.
Expand Down
2 changes: 1 addition & 1 deletion benchmark/run_1mo_benchmark.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
https://github.com/ipython/ipython/issues/10627
This script corresponds with GCPy 1.0.4. Edit this version ID if releasing
This script corresponds with GCPy 1.1.0. Edit this version ID if releasing
a new version of GCPy.
"""

Expand Down
2 changes: 1 addition & 1 deletion benchmark/run_1yr_fullchem_benchmark.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
https://github.com/ipython/ipython/issues/10627
This script corresponds with GCPy 1.0.4. Edit this version ID if releasing
This script corresponds with GCPy 1.1.0. Edit this version ID if releasing
a new version of GCPy.
"""

Expand Down
2 changes: 1 addition & 1 deletion benchmark/run_1yr_tt_benchmark.py
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@
https://github.com/ipython/ipython/issues/10627
This script corresponds with GCPy 1.0.4. Edit this version ID if releasing
This script corresponds with GCPy 1.1.0. Edit this version ID if releasing
a new version of GCPy.
"""

Expand Down
18 changes: 10 additions & 8 deletions docs/source/Release_guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,12 @@ This page describes some of the steps required for releasing new versions of GCP



1. For clarity, update version numbers to the new release in ``setup.py`` and the benchmark scripts.
2. Publish the release on Github.
3. Install ``twine`` using ``pip install twine``.
4. To package GCPy for publication to PyPi, run the following from the root of your local GCPy repository::
1. For clarity, update version numbers to the new release in ``setup.py``, _version.py, and the benchmark scripts.
2. Update CHANGELOG.md
3. Merge main with dev
4. Publish the release on Github.
5. Install ``twine`` using ``pip install twine``.
6. To package GCPy for publication to PyPi, run the following from the root of your local GCPy repository::

run python setup.py sdist bdist_wheel
run twine check dist/*
Expand All @@ -19,9 +21,9 @@ This page describes some of the steps required for releasing new versions of GCP


5. Publish to PyPi by running ``run twine upload dist/*``, and enter your login information for pypi.org as requested.
6. Verify the new release is visible at https://pypi.org/project/geoschem-gcpy/ (may take a few minutes).
7. After a period of time (around an hour), you will be notified of a new PR at https://github.com/conda-forge/geoschem-gcpy-feedstock indicating conda-forge has
7. Publish to PyPi by running ``run twine upload dist/*``, and enter your login information for pypi.org as requested.
8. Verify the new release is visible at https://pypi.org/project/geoschem-gcpy/ (may take a few minutes).
9. After a period of time (around an hour), you will be notified of a new PR at https://github.com/conda-forge/geoschem-gcpy-feedstock indicating conda-forge has
detected a new release on PyPi. You should be able to merge this PR without any additinal interference once all checks have passed.
8. Once the feedstock PR has been merged and after another period of waiting, you should see builds for the new release when running ``conda search -f geoschem-gcpy``.
10. Once the feedstock PR has been merged and after another period of waiting, you should see builds for the new release when running ``conda search -f geoschem-gcpy``.
This indicates the new version is publicly available for installation through conda-forge.
2 changes: 1 addition & 1 deletion gcpy/_version.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@

__version__ = '1.0.3'
__version__ = '1.1.0'
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@
]

MAJOR = 1
MINOR = 0
MICRO = 3
MINOR = 1
MICRO = 0
EXTRA = '' # for alpha (aN), beta (bN), rc (rcN) versions

VERSION = "{}.{}.{}{}".format(MAJOR, MINOR, MICRO, EXTRA)
Expand Down

0 comments on commit b113e3c

Please sign in to comment.