Embed#

Main embedding functionality.

nbed.embed.cli() → None[source]#

CLI Interface.

nbed.embed.nbed(config: NbedConfig | str | None = None, **config_kwargs)[source]#

Import interface for the nbed package.

This function calls the NbedDriver class to create a second quantized hamiltonian using configuration provided.

Parameters:

  • config (NbedConfig) – A validated config model or path to a ‘.json’ config file.

  • **config_kwargs – Allows arbitrary keyword arguments for manual configuration.

Returns:

An embedded driver.

Return type:

NbedDriver

nbed.embed.overwrite_config_kwargs(config: NbedConfig, **config_kwargs) → NbedConfig[source]#

Overwrites config values with key-words and revalidates.

Parameters:

  • config (NbedConfig) – A config model.

  • config_kwargs (dict) – Any possible key-word arguments.

Returns:

A validated config model.

Return type:

NbedConfig

Raises:

ValidationError – If key-word arguments provided are not part of model.