search

geoschem / geos-chem

GEOS-Chem "Science Codebase" repository. Contains GEOS-Chem science routines, run directory generation scripts, and interface code. This repository is used as a submodule within the GCClassic and GCHP wrappers, as well as in other modeling contexts (external ESMs).
http://geos-chem.org
Other
167 stars 160 forks source link

[FEATURE REQUEST] Maintaining Documentation for Recent Model Versions #1359

Closed cdholmes closed 2 years ago

cdholmes commented 2 years ago

Request a new GEOS-Chem feature:

It would be very helpful if documentation could be maintained for recent model versions.

It seems that we are losing documentation for prior versions as soon as a new version comes out (or even before). Since many users continue to use a single version for the duration of a research project (commonly 1-2 years), I think there is a need to retain information on how to use recent prior versions.

For example, I am running version 13.4 and I am looking at the "Configure your simulation" on readthedocs.io. As you know, version 13.4 and all prior versions of GEOS-Chem use input.geos to configure many simulation options. The documentation page describes "geoschem_config.yml" and doesn't mention the input.geos file. I think the yml file is used in version 14.0, which isn't even released yet, so the documentation is out of step with what most users will need.

It appears that readthedocs.io has the capability to display documentation for multiple versions, which the user can select on the lower left corner of the webpage. That would be ideal. If the documentation for older versions is already retained somewhere, then I think directing users to it would be helpful.

Thanks!

yantosca commented 2 years ago

Thanks for writing @cdholmes. Most of the RTD doc for GC and HEMCO wasn't written before 14.0.0. So going forward we will have the ability to preserve older versions.

The [Getting Started with GEOS-Chem]{http://wiki.geos-chem.org/Getting_Started_with_GEOS-Chem) wiki manual has been updated to point to the https://geos-chem.readthedocs.io where content is the same between versions 13 and 14. Sections that are specific to older versions (eg. like the input.geos description) have been preserved there.

cdholmes commented 2 years ago

That's good that you plan to retain the prior wiki manual. Changing a few words could clarify things. At the top of Getting Started with GEOS-Chem, it says, "We will preserve the user manual content for GEOS-chem users who are still working with versions prior to 13.0.0."

That could be changed to "...working with versions 13.4 and earlier." It currently sounds like the 13 series info is on RTD.

yantosca commented 2 years ago

Good point @cdholmes. I'll fix it.

yantosca commented 2 years ago

Now fixed in http://wiki.geos-chem.org/Getting_Started_with_GEOS-Chem.