Skip to content

Document musica-cli usage in README and docs#704

Merged
K20shores merged 3 commits intomainfrom
copilot/document-musica-cli-usage
Dec 9, 2025
Merged

Document musica-cli usage in README and docs#704
K20shores merged 3 commits intomainfrom
copilot/document-musica-cli-usage

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Dec 5, 2025 •
edited
Loading

The musica-cli had no documentation. Users had no way to discover available options or examples without inspecting source code.

Changes

  • README.md: Added CLI section with options table, examples table, and usage workflows
  • docs/source/user_guide/cli.rst: New dedicated CLI documentation page
  • docs/source/user_guide/index.rst: Added cli.rst to Python section toctree

Usage

# Install with tutorial dependencies
pip install 'musica[tutorial]'

# Copy an example
musica-cli -e TS1LatinHyperCube

# Convert v0 config to v1
musica-cli --convert /path/to/config.json -o /path/to/output/

Available Options

Option Description
-e, --example Copy out a named example
-o, --output Output path
-v, --verbose Increase verbosity (-v info, -vv debug)
--convert Convert MUSICA v0 config to v1 format
--version Show version

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • ncar.github.io
    • Triggering command: /home/REDACTED/.local/bin/sphinx-build sphinx-build -M html source build (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

This section details on the original issue you should resolve

<issue_title>Document musica-cli usage in the readme</issue_title>
<issue_description>We don't have any instructions in the readme for the musica-cli. Add some

Acceptance criteria

  • The musica-cli has some documented options in the README
  • The docs contain a section for the musica-cli

Ideas

  • This may be a starting place:
Make some sort of python environment
conda create --name musica_312 python=3.12
conda activate musica_312

Install musica
pip install 'musica[tutorial]'

Make sure the version is 0.12.1
musica-cli --version

Inspect the command line help to see what options we have
musica-cli -h

Copy the TS1 example, get the configuration
musica-cli -e TS1LatinHyperCube
git clone https://github.com/NCAR/musica
cp -r musica/configs .
```</issue_description>

## Comments on the Issue (you are @copilot in this section)

<comments>
</comments>

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Copilot AI changed the title [WIP] Add documentation for musica-cli usage in README Document musica-cli usage in README and docs Dec 5, 2025
Copilot AI requested a review from K20shores December 5, 2025 16:16
@codecov-commenter
Copy link
Copy Markdown

codecov-commenter commented Dec 5, 2025 •
edited
Loading

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.55%. Comparing base (ad63a08) to head (218b2c8).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files 
@@           Coverage Diff           @@
##             main     #704   +/-   ##
=======================================
  Coverage   81.55%   81.55%           
=======================================
  Files         114      114           
  Lines        9912     9912           
=======================================
  Hits         8084     8084           
  Misses       1828     1828
Flag Coverage Δ
cpp_fortran 79.71% <ø> (ø)
javascript 92.12% <ø> (ø)
python 82.71% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@K20shores K20shores marked this pull request as ready for review December 5, 2025 18:54
@K20shores K20shores requested a review from boulderdaze December 5, 2025 18:54
@K20shores K20shores merged commit e69419d into main Dec 9, 2025
141 of 160 checks passed
@K20shores K20shores deleted the copilot/document-musica-cli-usage branch December 9, 2025 19:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@boulderdaze boulderdaze boulderdaze approved these changes

+1 more reviewer

@K20shores K20shores K20shores approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@K20shores K20shores

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Document musica-cli usage in the readme

4 participants

@codecov-commenter @K20shores @boulderdaze