nanover.jupyter.utilities module

class nanover.jupyter.utilities.InteractionsUtility(state: StateService)

Bases: StateKeysUtility

prefix = 'interaction.'

remove_interaction(key: str)

update_interaction(key: str, interaction: ParticleInteraction)

class nanover.jupyter.utilities.ModesManager(utilities: NanoverServerUtilities)

Bases: object

add_mode(mode: Mode, name: str, icon='👆')

add_normal_mode()

clear_all_modes()

enter_mode(name='normal', *, notify=True)

remove_mode(name: str)

class nanover.jupyter.utilities.NanoverClientUtilities(client: NanoverImdClient)

Bases: NanoverSharedUtilities

classmethod from_client(client: NanoverImdClient)

class nanover.jupyter.utilities.NanoverServerUtilities(runner: OmniRunner)

Bases: NanoverSharedUtilities

add_interaction_mode(mode: Mode, name: str, icon='👆')

define_command(key: str, *, handler: Callable[[...], dict | None], icon='❓', label='unnamed command')

static from_client(client: NanoverImdClient)

classmethod from_runner(runner: OmniRunner)

get_shared_state_value(key: str, default=None)

hide_solvent()

intersect_transform_handles(point) → dict | None

make_ghost_from_frame_data(key: str, *, frame_data: FrameData, atom_indices: Iterable[int])

make_ghost_from_mdanalysis(key: str, *, atoms)

mark_checkpoint()

notify_all(message: str)

property scene_transform: Transform

set_shared_state_value(key: str, value)

show_controls()

show_logging()

start_recording()

stop_recording()

use_recording_commands()

use_transform_handles()

class nanover.jupyter.utilities.NanoverSharedUtilities(app_server: AppServerMinimalImd)

Bases: object

class nanover.jupyter.utilities.PanelsUtility(state: StateService)

Bases: StateKeysUtility

static button(label='button', command='test/hello', arguments=None)

static header(label='header')

prefix = 'panel.'

remove_panel(key: str)

static slider(label='slider', variable='variable.dummy', range=(0.0, 1.0), integer=False, step=None)

update_panel(key: str, *elements: Any, position=(0.0, 0.0, 0.0), label='Unnamed panel', **kwargs)

class nanover.jupyter.utilities.SceneObjectsUtility(state: StateService)

Bases: StateKeysUtility

prefix = 'object.'

remove_label(key: str)

remove_line(key: str)

remove_shape(key: str)

remove_sprite(key: str)

update_label(key: str, *, text='label', position=(0.0, 0.0, 0.0), color=(1.0, 1.0, 1.0, 1.0), size=0.05, parent='simulation', **kwargs)

update_line(key: str, *, positions=((0.0, 0.0, 0.0), (1.0, 1.0, 1.0)), colors=None, color=(1.0, 1.0, 1.0, 1.0), size=0.05, parent='simulation', **kwargs)

update_shape(key: str, *, shape='sphere', position=(0.0, 0.0, 0.0), color=(1.0, 1.0, 1.0, 1.0), size=0.1, parent='simulation', **kwargs)

update_sprite(key: str, *, texture: str, position=(0.0, 0.0, 0.0), color=(1.0, 1.0, 1.0, 1.0), size=1.0, parent='simulation', **kwargs)

class nanover.jupyter.utilities.SelectionsUtility(state: StateService)

Bases: StateKeysUtility

modify_selection(key: str, *, particle_ids: list[int] | None = None, renderer: dict | str | None = None, interaction_method: str | None = None, velocity_reset: bool | None = False, hide: bool | None = None)

prefix = 'selection.'

remove_selection(key: str)

update_selection(key: str, *, particle_ids: list[int] | None = None, renderer='liquorice', interaction_method='single', velocity_reset=False, hide=False)

class nanover.jupyter.utilities.StateKeysUtility(state: StateService)

Bases: object

all_prefixed()

all_prefixed_items()

check_flush()

clear()

clear_all()

flush()

classmethod from_client(client: NanoverImdClient)

classmethod from_runner(runner: OmniRunner)

prefix = ''

remove_object(key: str)

update_object(key: str, value: dict[str, Any])

class nanover.jupyter.utilities.StateTransformEntry

Bases: TypedDict

parent: str | None

transform: Sequence[float]

class nanover.jupyter.utilities.TransformHandlesUtility(state: StateService)

Bases: StateKeysUtility

prefix = 'handle.'

remove_handle(key: str)

update_handle(key: str, *, parent: str, sphere=((0, 0, 0), 0.25), translate=True, rotate=True, scale=False, **kwargs)

class nanover.jupyter.utilities.TransformsUtility(state: StateService)

Bases: StateKeysUtility

fetch_transform(key: str, *, default: Transform | None = None)

fetch_transform_entry(key: str) → StateTransformEntry | None

fetch_transform_root(key: str)

get_parent(key: str, *, default=None)

prefix = 'transform.'

remove_transform(key: str)

update_transform(key: str, *, transform: Transform, parent='simulation')

nanover.jupyter.utilities.make_id_generator(prefix='')