Add .readthedocs.yaml; Update badges in README.md

.readthedocs.yaml
- Added per instructions in readthedocs/readthedocs.org #10290

README.md
- Updated title to "HEMCO: The Harmonized Emissions Component"
- Now use HTML for badge links (it's easier)

CHANGELOG.md
- Updated accordingly

Signed-off-by: Bob Yantosca <[email protected]>

.readthedocs.yaml

@@ -0,0 +1,34 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+#
+# NOTE: This is now needed in order to prevent builds from failing due
+# to Python package issues at the ReadTheDocs site. For more info, see:
+# https://github.com/readthedocs/readthedocs.org/issues/10290
+#   -- Bob Yantosca (10 May 2023)
+
+# Required
+version: 2
+
+## Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.7"
+    nodejs: "14"
+    rust:   "1.55"
+    golang: "1.17"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  builder: html
+  configuration: docs/source/conf.py
+
+# If using Sphinx, optionally build your docs in additional formats such as PDF
+#formats:
+#  - pdf
+
+# Optionally declare the Python requirements required to build your docs
+python:
+  install:
+  - requirements: docs/requirements.txt

CHANGELOG.md

@@ -6,10 +6,15 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
+### Added
+- Added `.readthedocs.yaml` file to configure ReadTheDocs builds
+
+### Changed
 - Updated ReadTheDocs documentation about time cycle options `RFY`, `RFY3`
 - Updated ReadTheDocs documentation about the `HEMCO_Diagn.rc` file
 - Updated `AUTHORS.txt` for GEOS-Chem 14.2.0 and HEMCO 3.7.0
 - Updated formatting in `README.md`
+- Updated title and links to badges in `README.md`
 
 ## [3.6.2] - 2023-03-02
 ### Added

README.md

@@ -1,8 +1,19 @@
-# README for the HEMCO source code repository
+# HEMCO: The Harmonized Emissions Component
 
-[![Latest Pre-Release](https://img.shields.io/github/v/release/geoschem/HEMCO?include_prereleases&label=Latest%20Pre-Release)](https://github.com/geoschem/HEMCO/releases) [![Latest Stable Release](https://img.shields.io/github/v/release/geoschem/HEMCO?label=Latest%20Stable%20Release)](https://github.com/geoschem/HEMCO/releases) [![Release Date](https://img.shields.io/github/release-date/geoschem/HEMCO)](https://github.com/geoschem/HEMCO/releases) [![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/geoschem/HEMCO/blob/main/LICENSE.txt) [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4618253.svg)](https://doi.org/10.5281/zenodo.4618253) [![RTD](https://img.shields.io/readthedocs/hemco?label=ReadTheDocs)](https://hemco.readthedocs.io/en/latest/) [![Azure](https://dev.azure.com/geoschem/hemco/_apis/build/status/Quick%20Build?branchName=dev)](https://dev.azure.com/geoschem/hemco/_apis/build/status/Quick%20Build?branchName=dev)
+<p>
+  <a href="https://github.com/geoschem/hemco/releases"><img src="https://img.shields.io/github/v/release/geoschem/hemco?include_prereleases&label=Latest%20Pre-Release"></a>
+  <a href="https://github.com/geoschem/hemco/releases"><img src="https://img.shields.io/github/v/release/geoschem/hemco?label=Latest%20Stable%20Release"></a>
+  <a href="https://github.com/geoschem/hemco/releases/"><img src="https://img.shields.io/github/release-date/geoschem/hemco"></a>
+  <br />
+  <a href="https://doi.org/10.5281/zenodo.4618253"><img src="https://zenodo.org/badge/DOI/10.5281/zenodo.4618253.svg" alt="DOI"></a>
+  <a href="https://github.com/geoschem/hemco/blob/main/LICENSE.txt"><img src="https://img.shields.io/badge/License-MIT-blue.svg"></a>
+  <a href="https://hemco.readthedocs.io/en/latest/"><img src="https://img.shields.io/readthedocs/geos-chem?label=ReadTheDocs"></a>
+</p>
 
-This repository (https://github.com/geoschem/HEMCO) contains the Harmonized Emissions Component (HEMCO) source code. HEMCO is a software component for computing (atmospheric) emissions from different sources, regions, and species on a user-defined grid. It can combine, overlay, and update a set of data inventories ('base emissions') and scale factors, as specified by the user through the HEMCO configuration file. Emissions that depend on environmental variables and non-linear parameterizations are calculated in separate HEMCO extensions. HEMCO can be run in standalone mode or coupled to an atmospheric model. A more detailed descriptio n of HEMCO is given in Keller et al. (2014) and Lin et al (2021).
+## Description
+
+This repository (https://github.com/geoschem/HEMCO) contains the Harmonized Emissions Component (HEMCO) source code. HEMCO is a software component for computing (atmospheric) emissions from different sources, regions, and species on a user-defined grid. It can combine, overlay, and update a set of data inventories ('base emissions') and scale factors, as specified by the user through the HEMCO configuration file. Emissions that depend on environmental variables and non-linear parameterizations are calculated in separate HEMCO extensions. HEMCO can be run
+in standalone mode or coupled to an atmospheric model. A more detailed description of HEMCO is given in Keller et al. (2014) and Lin et al (2021).
 
 HEMCO has been coupled to several atmospheric and Earth System Models, and can be coupled with or without using the Earth System Modeling Framework (ESMF). A detailed description of HEMCO coupled with other models is given in Lin et al. (2021).
 
@@ -23,4 +34,4 @@ We encourage GEOS-Chem users to use [the Github issue tracker attached to this r
 
 ## License
 
-HEMCO is distributed under the MIT license. Please see the license documents LICENSE.txt and AUTHORS.txt in the root folder.
+HEMCO is distributed under the MIT license. Please see the license documents LICENSE.txt and AUTHORS.txt in the root folder.