Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
blaylockbk committed Dec 17, 2023
1 parent 69becda commit 2f1a90d
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 24 deletions.
4 changes: 2 additions & 2 deletions CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ authors:
email: [email protected]
orcid: "https://orcid.org/0000-0003-2133-9313"
title: "Herbie: Retrieve Numerical Weather Prediction Model Data"
version: 2023.3.0
date-released: "2023-03-11"
version: 2023.12.3
date-released: "2023-12-16"
url: "https://herbie.readthedocs.io/"
repository-code: "https://github.com/blaylockbk/Herbie"
type: software
Expand Down
23 changes: 14 additions & 9 deletions HOW-TO-RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,16 @@ Update Herbie version number in

- Update `./CITATION.cff` citation document
- Update `./docs/_static/switcher.json` with a new item for the version you will soon create
- Make sure all leftover changes on main are committed that you want.
- **Create a tag and release in GitHub**.
- (You will need to go into the readthedocs.org dashboard and activate the version later.)
- Make sure all leftover changes on main are committed that you want.
- **Create a tag and release in GitHub**.

> Note: The tag name should follow the pattern `YYYY.MM.0`
>
> - `YYYY` is the four-digit year the tag is created.
> - `MM` is the month number the tag is created with _no leading zeros_ (PyPI doesn't care about leading zeros).
> - `0` - The micro update, set to `0` for the first release of the month, otherwise increment by 1 if there is more than one release in the same month (i.e., a bug fix).
>> Note: I do _NOT_ prepend the version name with `v`.
> - `0` - The micro update, set to `0` for the first release of the month, otherwise increment by 1 if there is more than one release in the same month (i.e., a bug fix).
> > Note: I do _NOT_ prepend the version name with `v` (I have chosen to not include that.)
## 📦 Publish to PyPI

Expand All @@ -28,7 +30,6 @@ The build process will start automatically.
1. The action uses the [build](https://github.com/pypa/build) tool to build my package following the steps from [here](https://towardsdatascience.com/how-to-package-your-python-code-df5a7739ab2e).
1. The action then uses [pypa/gh-action-pypi-publish](https://github.com/pypa/gh-action-pypi-publish#specifying-a-different-username) to upload the package to PyPI


After the action completes, confirm the file was uploaded to PyPI at <https://pypi.org/project/herbie-data/>.

## 🐍 Publish to Conda
Expand All @@ -37,13 +38,17 @@ Updating the Conda package involves updating the herbie-data feedstock, specific

1. Fork the [herbie-data Conda feedstock](https://github.com/conda-forge/herbie-data-feedstock/pull/1/checks?check_run_id=11936300099)
1. Follow the instructions in the README to update the build
- Update version
- Update sha256 has for the `herbie-data-{version}.tar.gz` file (found on PyPI) in the "Download files" tab.
- Set build to 0 for releasing a new version.
- Update version
- Update sha256 has for the `herbie-data-{version}.tar.gz` file (found on PyPI) in the "Download files" tab.
- Set build to 0 for releasing a new version.
1. Create pull request.
1. Follow instructions in the pull request template.

---
## 📄 readthedocs

1. If a new version is included in the version switcher, then you'll need to activate the pages for that version.

<hr>

# Miscellaneous

Expand Down
24 changes: 11 additions & 13 deletions docs/user_guide/install.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# 🐍 Installation

## conda install

[![Conda](https://img.shields.io/conda/v/conda-forge/herbie-data)](https://anaconda.org/conda-forge/herbie-data)

The easiest way to install Herbie and its dependencies is with [Conda](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html) from conda-forge.
Expand All @@ -8,19 +10,7 @@ The easiest way to install Herbie and its dependencies is with [Conda](https://d
conda install -c conda-forge herbie-data
```

## Carpenter Workshop 🧰 (optional)

An _optional_ dependency is my "Carpenter Workshop" package. This has some general tools that are useful for making maps and performing other tasks. You might see me use these tools in the tutorials.

```bash
pip install git+https://github.com/blaylockbk/Carpenter_Workshop.git
```

<br>
<br>
<br>

# pip install
## pip install

[![PyPI - Version](https://img.shields.io/pypi/v/herbie-data)](https://pypi.org/project/herbie-data/)

Expand Down Expand Up @@ -54,3 +44,11 @@ git clone https://github.com/blaylockbk/Herbie.git
cd Herbie
pip install -e .
```

# Carpenter Workshop 🧰 (optional)

An _optional_ dependency is my [Carpenter Workshop](https://github.com/blaylockbk/Carpenter_Workshop) package. This has some general tools that are useful for making maps and performing other tasks. You might see me use these tools in the tutorials.

```bash
pip install git+https://github.com/blaylockbk/Carpenter_Workshop.git
```

0 comments on commit 2f1a90d

Please sign in to comment.