Skip to content

Minor edits to the install guide#1470

Merged
ktangsali merged 4 commits intoNVIDIA:2.0.0-rcfrom
ktangsali:update-install-guide
Mar 6, 2026
Merged

Minor edits to the install guide#1470
ktangsali merged 4 commits intoNVIDIA:2.0.0-rcfrom
ktangsali:update-install-guide

Conversation

@ktangsali
Copy link
Collaborator

PhysicsNeMo Pull Request

Description

Checklist

Dependencies

Review Process

All PRs are reviewed by the PhysicsNeMo team before merging.

Depending on which files are changed, GitHub may automatically assign a maintainer for review.

We are also testing AI-based code review tools (e.g., Greptile), which may add automated comments with a confidence score.
This score reflects the AI’s assessment of merge readiness and is not a qualitative judgment of your work, nor is
it an indication that the PR will be accepted / rejected.

AI-generated feedback should be reviewed critically for usefulness.
You are not required to respond to every AI comment, but they are intended to help both authors and reviewers.
Please react to Greptile comments with 👍 or 👎 to provide feedback on their accuracy.

@ktangsali ktangsali requested a review from peterdsharpe March 4, 2026 23:48
@greptile-apps
Copy link
Contributor

greptile-apps bot commented Mar 4, 2026

Greptile Summary

This PR makes minor editorial improvements to the Installation section of README.md, making the guide more concise and upfront about the two supported installation paths (pip/uv and NVIDIA container image). No functional or factual changes are introduced.

  • Rewrote the intro paragraph to immediately surface both supported install methods.
  • Collapsed two separate intro paragraphs into one for brevity.
  • Simplified the PyPI section subheading from a full sentence to a short imperative phrase.
  • Added "from source" to the uv section to clarify its intended use-case.
  • Removed "recommended" from the NVCR Container section, treating all methods equally.

Important Files Changed

Filename Overview
README.md Minor editorial updates to the Installation section: rewrote intro paragraph to surface both install methods upfront, simplified the PyPI section header, added "from source" to the uv section, and removed "recommended" from the NVCR Container heading. No factual inaccuracies or broken links introduced.

Last reviewed commit: 5f52411

Copy link
Collaborator

@peterdsharpe peterdsharpe left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ktangsali ktangsali requested a review from megnvidia as a code owner March 6, 2026 02:49
@ktangsali ktangsali merged commit eda7e9a into NVIDIA:2.0.0-rc Mar 6, 2026
@ktangsali ktangsali deleted the update-install-guide branch March 6, 2026 02:56
ktangsali added a commit that referenced this pull request Mar 10, 2026
* minor edits to the install guide

* add more details

* minor doc fix

* add transolver to the api index
ktangsali added a commit that referenced this pull request Mar 10, 2026
* minor edits to the install guide

* add more details

* minor doc fix

* add transolver to the api index
ktangsali added a commit that referenced this pull request Mar 11, 2026
* minor edits to the install guide

* add more details

* minor doc fix

* add transolver to the api index
peterdsharpe added a commit to peterdsharpe/physicsnemo that referenced this pull request Mar 12, 2026
commit fb4f159
Author: Peter Sharpe <peterdsharpe@gmail.com>
Date:   Wed Mar 11 23:11:04 2026 -0400

    Adds the PhysicsNeMo-Mesh changes required for GLOBE 3D (NVIDIA#1483)

    * Adds the PhysicsNeMo-Mesh changes required for GLOBE 3D

    * Fixes docstring example for compute_cell_normals to reflect correct normal vector output in 2D case.

    * Refactor compute_cell_areas and compute_cell_normals functions to use match-case syntax for improved readability and maintainability.

commit 219aca3
Author: Peter Harrington <48932392+pzharrington@users.noreply.github.com>
Date:   Wed Mar 11 17:23:16 2026 -0700

    Fix window shift in pangu, fengwu (NVIDIA#1492)

    * Fix window shift in pangu, fengwu

    * changelog

commit 26fcdce
Author: Kaustubh Tangsali <ktangsali@nvidia.com>
Date:   Wed Mar 11 20:20:33 2026 +0000

    fix linting issues

commit ca15f47
Author: Charlelie Laurent <claurent@nvidia.com>
Date:   Wed Mar 11 12:08:12 2026 -0700

    Resolved conflicts in checkpoint.py

    Signed-off-by: Charlelie Laurent <claurent@nvidia.com>

commit 95eca0c
Author: Kaustubh Tangsali <ktangsali@nvidia.com>
Date:   Tue Mar 10 23:27:40 2026 +0000

    remove the conflict block

commit 33d9a7e
Author: Kaustubh Tangsali <ktangsali@nvidia.com>
Date:   Tue Mar 10 23:22:22 2026 +0000

    update versioins

commit fbfb896
Author: Charlelie Laurent <84199758+CharlelieLrt@users.noreply.github.com>
Date:   Mon Mar 9 16:42:38 2026 -0700

    Improved docs for module.py + multiple cleanups in docs (NVIDIA#1478)

    * Improved docs for module.py

    Signed-off-by: Charlelie Laurent <claurent@nvidia.com>

    * Fix in save_checkpoint and load_checkpoint docstrings

    Signed-off-by: Charlelie Laurent <claurent@nvidia.com>

    * Addressed PR comments

    Signed-off-by: Charlelie Laurent <claurent@nvidia.com>

    * Improvements in docs

    Signed-off-by: Charlelie Laurent <claurent@nvidia.com>

    * Moved down section about static capture in physicsnemo.utils.rst

    Signed-off-by: Charlelie Laurent <claurent@nvidia.com>

    ---------

    Signed-off-by: Charlelie Laurent <claurent@nvidia.com>

commit 13c6fb4
Author: Corey adams <6619961+coreyjadams@users.noreply.github.com>
Date:   Mon Mar 9 11:25:44 2026 -0500

    Update Datapipes API (NVIDIA#1468)

    * Trying again with datapipes check in

    * Update docs/api/datapipes/physicsnemo.datapipes.cae.rst

    Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>

    * Update docs/api/datapipes/physicsnemo.datapipes.cae.rst

    Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>

    * Update docs/api/datapipes/physicsnemo.datapipes.rst

    Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>

    * Update docs/api/datapipes/physicsnemo.datapipes.rst

    Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>

    * Update docs/api/datapipes/physicsnemo.datapipes.rst

    Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>

    * Update docs/api/datapipes/physicsnemo.datapipes.rst

    Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>

    * Update docs/api/datapipes/physicsnemo.datapipes.rst

    Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>

    * Update docs/api/datapipes/physicsnemo.datapipes.transforms.rst

    Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>

    * Resolve api commits for datapipes

    * Remove old datapipes api

    * Add link to the datapipe docs.

    ---------

    Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>

commit 32f2261
Author: Charlelie Laurent <84199758+CharlelieLrt@users.noreply.github.com>
Date:   Fri Mar 6 15:31:53 2026 -0800

    Fix unresolved conflict (NVIDIA#1477)

    Signed-off-by: Charlelie Laurent <claurent@nvidia.com>

commit 9a32517
Author: Charlelie Laurent <84199758+CharlelieLrt@users.noreply.github.com>
Date:   Fri Mar 6 15:09:50 2026 -0800

    Diffusion API docs (NVIDIA#1473)

    * New API docs for diffusion

    Signed-off-by: Charlelie Laurent <claurent@nvidia.com>

    * Some fixes in nested API references

    Signed-off-by: Charlelie Laurent <claurent@nvidia.com>

    * Revert some changes

    Signed-off-by: Charlelie Laurent <claurent@nvidia.com>

    * Some fixes

    Signed-off-by: Charlelie Laurent <claurent@nvidia.com>

    * Some clarifications in introduction.rst

    Signed-off-by: Charlelie Laurent <claurent@nvidia.com>

    * Some clarification in diffusion models.rst

    Signed-off-by: Charlelie Laurent <claurent@nvidia.com>

    * Fixed note sections in preconditioners.py

    Signed-off-by: Charlelie Laurent <claurent@nvidia.com>

    * Fix some broken short-form refs in losses.py

    Signed-off-by: Charlelie Laurent <claurent@nvidia.com>

    * Updated DPSScorePredictor class name in samplers.rst

    Signed-off-by: Charlelie Laurent <claurent@nvidia.com>

    * Enhance clarity and structure of introduction section

    Refactor introduction section for clarity and readability. Improve formatting and organization of key concepts related to the PhysicsNeMo diffusion framework.

    * Refactor metrics.rst for improved clarity and formatting

    Reformatted the description of the module to use bullet points for clarity. Adjusted wording for consistency and readability.

    * Fix punctuation and enhance clarity in models.rst

    Corrected punctuation and improved clarity in the documentation.

    * Addressed PR comments

    Signed-off-by: Charlelie Laurent <claurent@nvidia.com>

    ---------

    Signed-off-by: Charlelie Laurent <claurent@nvidia.com>
    Co-authored-by: megnvidia <mmiranda@nvidia.com>

commit d723767
Author: Kaustubh Tangsali <71059996+ktangsali@users.noreply.github.com>
Date:   Thu Mar 5 18:56:46 2026 -0800

    Minor edits to the install guide (NVIDIA#1470)

    * minor edits to the install guide

    * add more details

    * minor doc fix

    * add transolver to the api index

commit 6bb6d04
Author: Charlelie Laurent <84199758+CharlelieLrt@users.noreply.github.com>
Date:   Thu Mar 5 12:38:13 2026 -0800

    Fixes and renaming in dps_guidance.py (NVIDIA#1471)

    Signed-off-by: Charlelie Laurent <claurent@nvidia.com>

commit 1e14a56
Author: Corey adams <6619961+coreyjadams@users.noreply.github.com>
Date:   Wed Mar 4 15:46:15 2026 -0600

    Update API docs and structure. (NVIDIA#1337)

    * Update API docs and structure.

    * clean-up and re-organization of docs

    * fix based on new api

    * remove unused sections

    * update image paths

    * Update docs/api/models/diffusion.rst

    Co-authored-by: megnvidia <mmiranda@nvidia.com>

    * Update docs/api/models/operators.rst

    Co-authored-by: megnvidia <mmiranda@nvidia.com>

    * Update docs/api/models/weather.rst

    Co-authored-by: megnvidia <mmiranda@nvidia.com>

    * Update docs/api/physicsnemo.core.rst

    Co-authored-by: megnvidia <mmiranda@nvidia.com>

    * Update docs/api/physicsnemo.diffusion.rst

    Co-authored-by: megnvidia <mmiranda@nvidia.com>

    * Update docs/api/physicsnemo.diffusion.rst

    Co-authored-by: megnvidia <mmiranda@nvidia.com>

    * Update docs/api/physicsnemo.utils.rst

    Co-authored-by: megnvidia <mmiranda@nvidia.com>

    * Update docs/api/physicsnemo.utils.rst

    Co-authored-by: megnvidia <mmiranda@nvidia.com>

    * Update docs/api/physicsnemo.utils.rst

    Co-authored-by: megnvidia <mmiranda@nvidia.com>

    * Update docs/api/physicsnemo.utils.rst

    Co-authored-by: megnvidia <mmiranda@nvidia.com>

    * Update docs/api/physicsnemo.utils.rst

    Co-authored-by: megnvidia <mmiranda@nvidia.com>

    * Update docs/api/physicsnemo.utils.rst

    Co-authored-by: megnvidia <mmiranda@nvidia.com>

    * Update docs/api/physicsnemo.utils.rst

    Co-authored-by: megnvidia <mmiranda@nvidia.com>

    * fix formatting

    ---------

    Co-authored-by: Kaustubh Tangsali <71059996+ktangsali@users.noreply.github.com>
    Co-authored-by: Kaustubh Tangsali <ktangsali@nvidia.com>
    Co-authored-by: megnvidia <mmiranda@nvidia.com>

commit f22cfbf
Author: Peter Sharpe <peterdsharpe@gmail.com>
Date:   Mon Mar 2 17:56:32 2026 -0500

    Adds PhysicsNeMo-Mesh API Docs (NVIDIA#1461)

    * Adds mesh docs on top of RC branch

    * Update docs/mesh/boundaries.rst

    Co-authored-by: megnvidia <mmiranda@nvidia.com>

    * Apply suggestions from code review

    Co-authored-by: megnvidia <mmiranda@nvidia.com>

    * Refine documentation for mesh geometry functions to clarify usage and API exposure for advanced cases.

    * better subdivision descriptions

    * clearer docs

    ---------

    Co-authored-by: megnvidia <mmiranda@nvidia.com>

commit 1e9fdd0
Author: Corey adams <6619961+coreyjadams@users.noreply.github.com>
Date:   Fri Feb 27 12:12:02 2026 -0600

    GeoTransolver: Fix attention and turn off feature broadcasting. (NVIDIA#1415)

    * Fix attention and turn off feature broadcasting.

    * Fix scalar loading shapes

    * Update volume.yaml

    Ensure the volume example works out of the box.

    * Fix Geotransolver inference tests

commit 4f0a3cb
Author: Kaustubh Tangsali <71059996+ktangsali@users.noreply.github.com>
Date:   Thu Feb 26 15:00:42 2026 -0800

    Wandb fixes (NVIDIA#1458)

    * Add wandb to requirements

    * Modify requirements for trimesh and add wandb

    Updated trimesh version constraint and added wandb.

commit 082cd36
Author: Kaustubh Tangsali <71059996+ktangsali@users.noreply.github.com>
Date:   Thu Feb 26 15:00:16 2026 -0800

    Fixes from SFB builds / testing (NVIDIA#1459)

    * Remove 'perf' extra from physicsnemo installation because NGC containers already include transformer-engine

    * update deterministic settings

commit f6ca818
Author: Charlelie Laurent <84199758+CharlelieLrt@users.noreply.github.com>
Date:   Wed Feb 25 13:20:46 2026 -0800

    Fix broken cross-ref links in docstrings (NVIDIA#1454)

    Signed-off-by: Charlelie Laurent <claurent@nvidia.com>

commit 47b8ff0
Author: Peter Sharpe <peterdsharpe@gmail.com>
Date:   Wed Mar 11 15:21:31 2026 -0400

    Deprecates `physicsnemo.utils.mesh.py` (NVIDIA#1487)

    * Adds DeprecationWarning on module.

    * Changelog update for deprecations

commit 74c91f9
Author: Peter Sharpe <peterdsharpe@gmail.com>
Date:   Wed Mar 11 14:20:25 2026 -0400

    Adds docstrings to CombinedOptimizer tests. (NVIDIA#1486)
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.

2 participants