Add getting-started notebook and YAML config reference doc - #130
Merged
Conversation
Adds notebooks/getting_started_with_cmac.ipynb walking through downloading a radar file + sonde, running cmac(), and generating quicklooks, and documents/cmac_config_reference.md documenting every section/key of the YAML config file accepted via config_file. Links both from README.rst. Also relocates the older exploratory xsapr_cmac_hook.ipynb and zdr_processing.ipynb notebooks into notebooks/cmac_development/ and removes notebooks that no longer reflect the current API (ADI_dask-jobqueue, DDLobes, Stratus_scaling_plots, stratus_cmac_cacti_csapr, stratus_cmac_i4, stratus_cmac_i5). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Copies introductory/motivation material from the CMAC2.0 technical report into the README and links the full report from both the Background and Documentation sections.
zssherman
approved these changes
Jul 22, 2026
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
2 participants
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.
This PR eliminates some outdated exploratory notebooks in the repo and adds an example notebook based off of modern data and syntax. In addition, there is now a user's guide with a new getting-started notebook and more introductory material in the main README.rst.
ARM-Development doesn't allow deployment of sphinx pages or I would set those up.
Co-authored by Claude Sonnet 5