Utiliser des scripts Python

À propos de la commande PIP

Avec la commande PIP, vous pouvez installer et gérer des packages Python, par exemple des packages personnalisés qui ne font pas partie de la bibliothèque standard Python.

À propos de la commande BIMPYTHON

La commande BIMPYTHON vous permet d'interroger et de gérer les données d'un modèle dans BricsCAD BIM, avec un fichier .py de script Python approprié.

Les scripts Python peuvent être aussi simples que d'obtenir des quantités et des propriétés associées d'objets et d'entités BIM, ou aussi élaborés que d'implémenter une série de calculs basés sur les paramètres de modèle disponibles.

Certains scripts utiles sont disponibles dans le dossier d'installation BricsCAD BIMC:\Users\%nom d'utilisateur% \AppData\Roaming\Bricsys\BricsCAD\V27x64\en_US\Support\Bim\Scripts :

  • calculate_weight.py permet de calculer le poids des entités en fonction de leur volume et de leur densité.
  • schedules.py permet de générer des horaires personnalisés et de les exporter vers des fichiers CSV.
  • set_name_and_number.py remplit les propriétés de nom et de numéro en fonction de l'étage, du type BIM et de leur position.
  • tag_to_number.py permet de copier le numéro d'identification, s'il fait partie du nom (après une importation IFC), dans la propriété Nombre.
  • thermal_transmittance.py calcule la transmission thermique en fonction de la conductivité thermique des couches.

Vous pouvez également utiliser des scripts depuis l'onglet Fichiers du panneau Navigateur de projet BIM (voir l'article du panneau Navigateur de projet BIM).

Remarque :
  • BricsCAD n'est pas livré avec un shell Python, les scripts doivent donc être préparés dans un éditeur de texte ou de code.
  • Le langage de programmation Python, ainsi que ses bibliothèques standard, sont intégrés à BricsCAD BIM. Il n'est donc pas nécessaire de les installer séparément, à moins que vous ne disposiez de paquets et de bibliothèques personnalisés que vous souhaitez utiliser dans vos scripts.

Exécution d'un script Python

  1. Ouvrez un fichier BricsCAD nouveau ou existant sur lequel vous voulez exécuter un script Python.
  2. Entrez BIMPYTHON dans la ligne de commande et appuyez sur Entrée.

    Ouvre la boîte de dialogue Sélectionner un script Python et exécute le script choisi.

  3. Sélectionnez un fichier PY, puis cliquez sur Ouvrir pour exécuter le script.
    Remarque : Si le script contient des modules qui ne sont pas déjà installés, BricsCAD affiche un message listant leurs noms. Utilisez la commande PIP pour les installer.
  4. À moins que vous n'ayez spécifié les données à exporter ou afficher dans un programme externe extérieur BricsCAD, BricsCAD rapporte la sortie en ligne de commande.

Configuration d'un script Python

Utilisez l'application de l'éditeur de texte ou de code de votre choix pour préparer le script. Ouvrez un nouveau fichier, écrivez le code nécessaire tel que décrit ci-dessous, puis enregistrez le fichier avec l'extension '.py'.

  1. Avant d'accéder à l'API, importez ou « appelez » les modules souhaités dans le script.
    Remarque : S'ils ne font pas partie de la bibliothèque Python standard, assurez-vous qu'ils ont été installés séparément au préalable. Pour cela, vous pouvez utiliser la commande PIP.

    Vous pouvez « importer » un module standard, tel que 'math' et « importer comme » un module externe, par exemple Pyplot, qui est un ensemble de fonctions dans le package matplotlib :

    import math 
    import matplotlib.pyplot as plt
  2. Après avoir appelées les bibliothèques de votre choix, l'étape suivante consiste à accéder à l'API afin d'interroger les éléments du modèle BricsCAD. C'est la gamme d'objets BIM et elle sert de point d'entrée au modèle.

    Importez le current_model depuis le module bricscad.bim :

    from bricscad.bim import current_model
  3. Vous pouvez maintenant interroger le modèle comme dans l'exemple suivant :
    # Display info about the lengths of walls in the model 
    lengths = [wall.prop('Length') for wall in current_model().filter(Type='Wall')] 
    print(f'wall lengths. max: {max(lengths)}, avg: {sum(lengths)/len(lengths)}') 
    # Create a selection and print the objects 
    current_model().filter(Type='Wall', IsExternal=True).select() 
    for wall in bim_model.filter(Type='Wall', IsExternal=True, Length=max(lengths)): 
        print(wall) 

    Les mappeurs des bricscad.bim.Objects peuvent être chaînés. Voici un exemple pour obtenir les parties du toit proches d'un mur :

    # Get all parts of roof within 40cm range of all walls 
    roof_parts = current_model().filter(Type='Roof').parts()
    roof_parts_close_to_wall = current_model().filter(Type='Wall').within_distance(40, 'cm', search_range=roof_parts) 

    Alors qu'il s'agit d'un exemple d'instruction de fonction à filtrer :

    # Filter roof parts longer than 50 project units 
    def is_long(obj):  
        return obj.prop('Length') > 50 
    roof_parts.filter(is_long) 
  4. Vous pouvez également exporter et afficher des données dans différents formats :

    # create a dictionary list 
    wall_info = [ 
        {   'Handle': wall.get_property('Handle'), 
            'Length': wall.get_property('Length'), 
            'Height': wall.get_property('Height') 
        } for wall in current_model().filter(Type='Wall')] 
    # export to .json 
    import json 
    file = open('C:\Users\%username%\Desktop\file.json', 'w+') 
    file.write(json.dumps(wall_info, indent=4)) 
    file.close() 
    # plotting a histogram 
    import matplotlib.pyplot as plt 
    import pandas as pd 
    df = pd.DataFrame(wall_info) 
    df.hist(); 
    plt.show() 
    # export to .csv 
    df.to_csv(r'C:\Users\%username%\Desktop\file.csv', index = False) 

Classes et syntaxes d'API BricsCAD

get_property(prop_name)
Renvoie la valeur de propriété de l'objet avec le nom donné.
set_property(prop_name, value)
Définit une valeur pour le nom de la propriété (prop_name).
distance_to(other_obj, units='mm', distance_mode='exact')
  • Calcule la distance entre deux objets.
  • Options pour les unités d'argument : toutes les unités de valeur forment des insunits (« Centimètres », « Pieds », « Parsecs », etc.) et les abréviations « mm », « cm », « m », « km » et « ft ».
  • Options pour l'argument distance_mode : 'bbox_center', 'bbox', exact'.
parts()
Renvoie les sous-éléments de cet objet.
parent()
L'inverse de parts() renvoie l'objet parent de ce sous-élément.
plies()
Renvoie l'objet itérable Couches associé.
within_distance(distance, unit='mm', distance_mode='exact', search_range=bim_model)
  • Retourne les objets compris dans la distance de l'argument.
  • Options pour les unités des arguments : voir distance_to.
  • Options pour l'argument distance_mode : voir distance_to.
openings()
Renvoie les ouvertures associées de cet objet.
spaces()
Renvoie les espaces associés de cet objet.
bounding_elements()
Renvoie les éléments de délimitation associés de cet objet (espace).
select()
Ajoute un objet à la sélection.
deselect()
Supprime un objet de la sélection.
__eq__() et __hash__()
Rend l'objet interopérable, par exemple, avec un jeu ou un dictionnaire Python.
classe bricscad.bim.Objects
Définit la collection des objets BricsCAD BIM
filter(function)
Filtre cette plage avec un paramètre de fonction.
filter( **conditions )
Filtre cette plage avec des conditions données sous forme d'arguments par mots-clés.
parts()
Retourne les parties de tous les éléments de cette plage.
parents()
Retourne les objets parents des éléments de cette plage.
within_distance(distance, unit='undefined', distance_mode='exact', search_range=bim_model)
Renvoie ces objets qui se trouvent à distance de n'importe quel objet de cette plage.
openings()
Renvoie les ouvertures associées de ces objets.
spaces()
Renvoie les espaces associés de ces objets.
bounding_elements()
Renvoie les éléments de délimitation associés de ces objets (espace).
select()
Ajoute des objets à la sélection.
deselect()
Supprime des objets de la sélection.
__len__ ()
Renvoie le nombre d'objets de cette plage.
bricscad.bim.list_properties (obj)
Renvoie la liste des propriétés disponibles de l'ancienne entité ou de la couche.
bricscad.bim.current_model()
Retourne les objets dans l'espace modèle du document actif.
class bricscad.bim.Plies
Conteneur indexé et découpable d'objets Couche :
__iter__()
__getitem__(index)
__getitem__(slice)
__len__()
classe bricscad.bim.Ply
Objet de la couche individuelle.
get_property(prop_name)
Renvoie la valeur de la propriété de l'objet Ply avec le nom donné.