Skip to content

Update installation.rst - #122

Merged
aylward merged 1 commit into
mainfrom
aylward-patch-1
Aug 20, 2026
Merged

Update installation.rst#122
aylward merged 1 commit into
mainfrom
aylward-patch-1

Conversation

@aylward

@aylward aylward commented Aug 20, 2026

Copy link
Copy Markdown
Collaborator

Recommend installing [all] option.

Summary by CodeRabbit

  • Documentation
    • Updated installation instructions to recommend the [all] package extra.
    • Clarified that this option includes PhysicsNeMo, CuPy, and development, testing, and documentation tools.
    • Added guidance to install CUDA-enabled PyTorch separately, as automatic resolution may vary by platform.

Recommend installing [all] option.

Signed-off-by: Stephen R. Aylward <stephen@aylward.org>
@coderabbitai

coderabbitai Bot commented Aug 20, 2026

Copy link
Copy Markdown

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 3d0ab321-14e0-46e9-8ea9-651028663593

📥 Commits

Reviewing files that changed from the base of the PR and between 52b4808 and ee6fae2.

📒 Files selected for processing (1)
  • docs/installation.rst

Cache: Disabled due to data retention organization setting

Knowledge base: Disabled due to data retention organization setting


Walkthrough

The installation documentation now recommends the [all] PyPI extra. It lists the included PhysicsNeMo, development, testing, and documentation dependencies. It also recommends pre-installing CUDA-enabled PyTorch because uv may not resolve CUDA 13 wheels on every platform.

Changes

Installation guidance

Layer / File(s) Summary
PyPI installation instructions
docs/installation.rst
The recommended installation uses the [all] extra. The documentation updates the dependency description and recommends pre-installing CUDA-enabled PyTorch when needed.

Estimated code review effort: 1 (Trivial) | ~2 minutes

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch aylward-patch-1

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@aylward
aylward merged commit 3ff18a4 into main Aug 20, 2026
6 of 7 checks passed
@aylward
aylward deleted the aylward-patch-1 branch August 20, 2026 15:51
@codecov

codecov Bot commented Aug 20, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 44.18%. Comparing base (52b4808) to head (ee6fae2).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #122   +/-   ##
=======================================
  Coverage   44.18%   44.18%           
=======================================
  Files          73       73           
  Lines        9352     9352           
=======================================
  Hits         4132     4132           
  Misses       5220     5220           
Flag Coverage Δ
integration-tests 44.00% <ø> (?)
unittests 44.18% <ø> (ø)

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

☔ View full report in Codecov by Harness.
📢 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant