Add updated documentation - #73
Merged
Merged
Conversation
Add quick start README for GFDL Vortex Tracker with installation instructions and documentation links
Updated README.md to enhance formatting and clarity.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds comprehensive documentation for the community release: a full User's Guide, a quick-start root README, and supporting reference/example assets. Replaces the outdated
docs/README.md.Changes
README.md(new, root) — Quick-start guide with condensed setup/run steps for both RDHPC and non-RDHPC users, sample track plot output, and links to the full User's Guidedocs/UserGuide.md(new) — Comprehensive User's Guide covering introduction, repository structure, getting started, installation and building (RDHPC, Spack, manual, and containerized methods), configuring and running the tracker, output files, troubleshooting, and additional resourcesdocs/README.md(removed) — Outdated documentation superseded bydocs/UserGuide.mdcompile/compiletrkr.sh— Removes thecontainerandpersonaloptions from the script's help text, since these are not yet functional and were misleadingly listed as available; they're planned for a future releasecompile/src_code/images/→docs/images/— Movedradiidoc_figure1.pngandradiidoc_figure2.pngto sit alongside the rest of the documentation assetsdocs/images/track_plot_examples/(new) — Example tropical cyclone track plot images (individual plots + composite gallery) referenced in the root README's "Sample Output" sectionrun/init_data/example_file.txt(new content) — Documents the required fixed-width column formatting forinit_data/config files (leadtimes.txt,hgt_levs.txt,tmp_levs.txt,vortex_tilt_levs.txt,vortex_tilt_vars.txt)Notes