Skip to content

Update licensing information in README - #115

Merged
aylward merged 1 commit into
mainfrom
clarify_research_licenses
Aug 6, 2026
Merged

Update licensing information in README#115
aylward merged 1 commit into
mainfrom
clarify_research_licenses

Conversation

@aylward

@aylward aylward commented Aug 6, 2026

Copy link
Copy Markdown
Collaborator

Clarified licensing terms for NVIDIA Omniverse and other dependencies.

Summary by CodeRabbit

  • Documentation
    • Updated the license information to distinguish NVIDIA Omniverse licensing.
    • Added optional non-commercial licensing details for supported medical imaging models.
    • Documented required license-key handling and how to disable these models.

Clarified licensing terms for NVIDIA Omniverse and other dependencies.

Signed-off-by: Stephen R. Aylward <stephen@aylward.org>
Copilot AI lite review requested due to automatic review settings August 6, 2026 17:38
@aylward
aylward merged commit 55dc2a8 into main Aug 6, 2026
1 of 2 checks passed
@coderabbitai

coderabbitai Bot commented Aug 6, 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: a31dd9b3-3282-4a2f-a26f-62049d56b67d

📥 Commits

Reviewing files that changed from the base of the PR and between ae78829 and 52ac137.

📒 Files selected for processing (1)
  • README.md

Cache: Disabled due to data retention organization setting

Knowledge base: Disabled due to data retention organization setting


Walkthrough

The README now separates NVIDIA Omniverse licensing from optional non-commercial licenses. It documents license-key requirements for NVIDIA Segment CT MRI weights and TotalSegmentator research-only models, including the set_has_academic_license(False) configuration.

Changes

Licensing documentation

Layer / File(s) Summary
License section updates
README.md
The License section identifies NVIDIA Omniverse licensing and documents non-commercial license restrictions, license-key behavior, and the set_has_academic_license(False) method.

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

Possibly related PRs

Suggested reviewers: copilot

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch clarify_research_licenses

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 deleted the clarify_research_licenses branch August 6, 2026 17:39

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Pull request overview

Updates the README’s License section to clarify licensing considerations for NVIDIA Omniverse and other optional dependencies used by PhysioTwin4D.

Changes:

  • Reworded the README license text related to NVIDIA Omniverse and added a direct link to the Omniverse license agreement.
  • Added a “Non-commercial Licenses (optional)” subsection covering NV-Segment-CTMR weight restrictions and TotalSegmentator research-only model licensing behavior.
Suppressed comments (1)

README.md:143

  • The TotalSegmentator bullet wraps onto a new line without indentation and uses triple backticks for inline code, which can break list formatting. Indent continuation lines and use single-backtick inline code spans for method/class references.
* TotalSegmentator includes the optional use of some of their research-only models. Using those models assumes that you have
the appropriate license key install, otherwise an error occurs.   Those models can be disabled by calling ```set_has_academic_license(False)``` member function of the ```SegmentChestTotalSegmentator``` class.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Comment on lines +136 to 137
Additionally, NVIDIA Omniverse is distributed under its own custom license, which makes it
free for academic and commercial use. https://docs.omniverse.nvidia.com/ov/latest/common/NVIDIA_Omniverse_License_Agreement.html
Comment thread README.md
Comment on lines 140 to 141
* NVIDIA Segment CT MRI AI weights (used in the SegmentNVSegmentCTMRI class,
are restricted from commercial use. https://github.com/NVIDIA-Medtech/NV-Segment-CTMR
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