Model.library_open#

Model.library_open(entities, libraryType, libraryName, user_settings_file_path='', workspace_name='', user='')#

Opens a library. Once the library is connected all entities are updated with information present in the library.

Parameters:

  • entities (EntityFullType) – The entity class stored in the library. Currently supported for parts and subsystems.

  • libraryType (hwString) – The type of library. Currently supported types are Local, Team, LM, and Objectstore.

  • libraryName (hwString) – The name of the library.

  • user_settings_file_path (hwString) – The path of the user settings file for connecting to the library.

  • workspace_name (hwString) – The path of the user settings file for connecting to the library.

  • user (hwString) – The library username.

Example#

Connect to a team Part library called PartLibrary_1#
import hm
import hm.entities as ent

model = hm.Model()

model.library_open(
    entities=ent.Part,
    libraryType="Team",
    libraryName="PartLibrary_1"
)
On this page