PhysicsNeMo Core#

The PhysicsNeMo core module provides the base functionality for the entire PhysicsNeMo framework. This encompasses filesystem and python utilities, the implementation of physicsnemo.Module and metadata, and the model registry.

PhysicsNemo Module#

The Module provides a base class for all user facing models in PhysicsNeMo. It provides a unified interface for the registry, checkpointing, and optimization. Full API information can be found in the PhysicsNeMo Modules.

Filesystem Utils#

Utilities for handling file operations, caching, and data management across different storage systems. These utilities abstract away the complexity of dealing with different filesystem types and provide consistent interfaces for data access.

class physicsnemo.core.filesystem.Package(root: str, seperator: str = '/')[source]#

Bases: object

A generic file system abstraction. Can be used to represent local and remote file systems. Remote files are automatically fetched and stored in the $LOCAL_CACHE or $HOME/.cache/physicsnemo folder. The get method can then be used to access files present.

Presently one can use Package with the following directories: - Package(“/path/to/local/directory”) = local file system - Package(“s3://bucket/path/to/directory”) = object store file system - Package(“http://url/path/to/directory”) = http file system - Package(“ngc://model/<org_id/team_id/model_id>@<version>”) = ngc model file system

Parameters:

  • root (str) – Root directory for file system

  • seperator (str, optional) – directory seperator. Defaults to “/”.

get(path: str, recursive: bool = False) → str[source]#

Get a local path to the item at path

path might be a remote file, in which case it is downloaded to a local cache at $LOCAL_CACHE or $HOME/.cache/physicsnemo first.