Skip to content

docs: Add comprehensive PhysicsNeMo code structure documentation#1292

Closed
ram-cherukuri wants to merge 3 commits intov2.0-refactorfrom
add-code-structure-readme
Closed

docs: Add comprehensive PhysicsNeMo code structure documentation#1292
ram-cherukuri wants to merge 3 commits intov2.0-refactorfrom
add-code-structure-readme

Conversation

@ram-cherukuri
Copy link
Copy Markdown
Collaborator

This PR adds a comprehensive code structure documentation file (PHYSICSNEMO_CODE_STRUCTURE.md) to help developers and users understand the PhysicsNeMo repository organization.

What's Included

  • Complete Directory Structure: Visual tree of the entire codebase
  • 20+ Model Architectures: Detailed documentation of AFNO, FNO, GraphCast, Diffusion models, MeshGraphNet, Transolver, and more
  • Neural Network Layers: Documentation of 50+ layer types including attention, convolution, Fourier layers, GNN layers, etc.
  • Data Pipelines: Climate, CFD, Healthcare, Geophysics data loading utilities
  • Metrics: Domain-specific evaluation metrics
  • Distributed Computing: Multi-GPU and domain parallelism documentation
  • Examples Overview: Guide to 776 example files across multiple domains
  • Testing Infrastructure: Overview of 281 test files
  • Getting Started Guide: Quick installation and usage instructions

Benefits

  • Helps new contributors understand the codebase structure
  • Provides a centralized reference for all components
  • Documents the relationship between different modules
  • Includes file statistics and dependency information

File Details

  • Location: \PHYSICSNEMO_CODE_STRUCTURE.md\
  • Size: 20.8 KB
  • Format: Markdown with table of contents

@coreyjadams
Copy link
Copy Markdown
Collaborator

I like the idea of this, but I think it's not something we can do cleanly with AI. We also have pieces in flight that it are missing (mesh, diffusion, nn). Probably, we should have this in our documentation instead, no?

Comment thread PHYSICSNEMO_CODE_STRUCTURE.md Outdated
Removed file statistics section from documentation.
Comment thread PHYSICSNEMO_CODE_STRUCTURE.md
Comment thread PHYSICSNEMO_CODE_STRUCTURE.md Outdated
Updated dependencies section and removed version information.
@coreyjadams
Copy link
Copy Markdown
Collaborator

We intercepted this in the contributing guide with a non-AI version. Closing this one.

@coreyjadams coreyjadams deleted the add-code-structure-readme branch March 10, 2026 01:31
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.

3 participants