Это многостраничный печатный вид этого раздела. Нажмите что бы печатать.

Вернуться к обычному просмотру страницы.

Начало работы

Пошаговое руководство по начальной настройке и использованию платформы для разработки плагинов для Autodesk Revit.

1: Установка

2: Настройка окружения

2.1: Необходимое ПО

2.2: Visual Studio

2.3: PyCharm

2.4: Плагины для Autodesk Revit

1 - Установка

Пошаговые инструкции по установке и настройке платформы для разработки.

Для успешного начала разработки на нашей платформе необходимо выполнить ряд шагов по установке и настройке необходимых инструментов. Следуйте данной инструкции, чтобы правильно настроить среду для работы с Revit и pyRevit.

Установка pyRevit

Перейдите на официальный сайт pyRevit и скачайте последнюю версию установщика для пользователя pyRevit_<version>_signed.exe.

pyRevit assets

Запустите установщик и следуйте инструкциям на экране для установки pyRevit.

Выбираем путь до места установки, в нашем случае должна быть папка %appdata%\pyRevit-Master как на скриншоте

Выбираем Full instalation

После установки откройте Revit и убедитесь, что вкладка pyRevit появилась в интерфейсе.

pyRevit

Установка платформы

Запустите PowerShell
Запустите следующие команды в PowerShell

Установка вкладки Admin

pyrevit extend ui 00.Admin "https://www.github.com/Bim4Everyone/AdminExtensions"

Установка вкладки 2D

pyrevit extend ui 01.2D "https://www.github.com/Bim4Everyone/2DExtensions"

Установка вкладки BIM

pyrevit extend ui 01.BIM "https://www.github.com/Bim4Everyone/BIMExtensions"

Установка вкладки АР

pyrevit extend ui 02.AR "https://www.github.com/Bim4Everyone/ARExtensions"

Установка вкладки КР

pyrevit extend ui 03.KR "https://www.github.com/Bim4Everyone/KRExtensions"

Установка вкладки ОВиВК

pyrevit extend ui 04.OV-VK "https://www.github.com/Bim4Everyone/HVACExtension"

Установка библиотеки Bim4Everyone

pyrevit extend lib Bim4Everyone "https://www.github.com/Bim4Everyone/Bim4Everyone"

После установки откройте Revit и убедитесь, что все установленные вкладки платформы появились в интерфейсе.

Bim4Everyone

Настройка окружения

Доступно в следующей статье: Настройка окружения

2 - Настройка окружения

Руководство по конфигурации и настройке рабочего окружения для разработки на платформе.

В данном разделе описаны необходимые и рекомендуемые инструменты для разработки платформы. Убедитесь, что перед началом работы на вашем ПК установлен Autodesk Revit, а также установлена сама платформа Bim4Everyone.

2.1 - Необходимое ПО

Руководство по установке и настройке необходимого ПО

Git

Git - это распределенная система контроля версий файлов.

Установка Git

Перейдите по ссылке и скачайте установочный файл Git for Windows. Запустите его и следуйте инструкциям по установке. Если вы незнакомы с Git, выбирайте значения по умолчанию. Если вы продвинутый пользователь, то вы уже сами знаете, что вам нужно.

Перезапустите ПК.

Настройка Git

Если у вас еще нет аккаунта на GitHub, то необходимо его создать.

В user.name напишите свой логин GitHub:

git config --global user.name "johndoe"

В user.email напишите свой публичный email, который привязан к GitHub:

git config --global user.email johndoe@example.com

Python

Python - это язык программирования, на котором можно легко и быстро писать простые плагины.

Установка Python

Для разработки плагинов на python необходимо установить последнюю версию Python2.7 (не путать с IronPython2.7). Для этого перейдите по ссылке и скачайте установочный файл:

Запустите его и следуйте инструкциям по установке. Выбирайте значения по умолчанию.

После установки перезапустите ПК

Notepad++

Notepad++ - это удобный бесплатный текстовый редактор для любого формата файлов.

Установка notepad++

Перейдите на сайт и скачайте установочный файл. Запустите его и следуйте инструкциям.

2.2 - Visual Studio

Руководство по установке и настройке Visual Studio.

Visual Studio - это IDE для разработки на C# с поддерживаемой бесплатной версией (Community Edition).

Установка

Перейдите по ссылке на официальный сайт и скачайте загрузочный файл программы установки. Запустите его и следуйте инструкциям по установке Visual Studio Installer. Когда появится окно для установки Visual Studio Community 2022, выберите следующие опции:

В Workloads выберите .NET desktop development:

В Language packs выберите English:

После завершения установки рекомендуется перезапустить ПК.

Настройка аккаунтов в Visual Studio

При первом запуске справа снизу выберите Continue without code:

В правом верхнем углу нажмите Sign in:

В появившемся окне выберите свой аккаунт Microsoft и введите пароль. Создайте аккаунт, если у вас еще нет аккаунта Microsoft. Далее добавьте аккаунт GitHub. Если вы еще не зарегистрировались на GitHub, сделайте это:

Настройка текстового редактора

Перейдите в Tools -> Options и задайте настройки, которые будут вам удобны.

Пример настроек текстового редактора (Text Editor):

Настройка автоформатирования при сохранении

Чтобы код автоматически форматировался в соответствии с .editorconfig, необходимо включить флаг в настройках:

Нажав на Configure Code Cleanup можно задать дополнительные действия:

Установка плагинов для Visual Studio

Перед установкой плагинов необходимо закрыть Visual Studio.

Установка Visual Studio Spell Checker

Данный плагин делает проверку орфографии.

Перейдите на страницу плагина, в Marketplace и скачайте установочный файл. Запустите его и следуйте инструкциям по установке.

Чтобы открыть настройки плагина, прейдите в Tools -> Spell Checker -> Edit Global Configuration:

Добавьте словари английского и русского языка:

Настройте опции проверки орфографии:

Сохраните настройки.

Добавление слов в словарь исключений

Чтобы добавить слово в словарь исключений, необходимо нажать Alt+Enter:

На момент написания этой инструкции в плагине есть особенность: нельзя сразу добавить слово в словарь, если это слово - название класса/пространства имен и прочее:

Обойти это можно, написав комментарий с этим словом, и добавив слово из комментария:

Установка Editor Guidelines

Данный плагин отображает максимальную длину строки в виде вертикальной линии.

Чтобы настроить цвет линии, перейдите в Tools -> Options -> Environment -> Fonts and Colors -> Guideline:

Установка VSColorOutput64

Данный плагин раскрашивает консольный вывод в цвета по типу сообщения вывода.

Чтобы настроить плагин, перейдите в Tools -> Options -> VSColorOutput64:

Установка dotnet tools

Чтобы установить dotnet tools, откройте powershell. Это можно сделать сразу в Visual Studio. Для этого перейдите в View -> Terminal:

Установка powershell tool

dotnet tool install --global PowerShell

Установка nuke tool

Nuke - это утилита для автоматизации сборки и публикации проектов.

dotnet tool install --global Nuke.GlobalTool

2.3 - PyCharm

Руководство по установке и настройке PyCharm.

PyCharm - это IDE для разработки на Python с поддерживаемой бесплатной версией (Community Edition).

Установка

Перейдите по ссылке на официальный сайт и скачайте установочный файл PyCharm Community Edition.

Запустите его и следуйте инструкциям по установке. Выберите следующие опции:

После установки перезапустите ПК

Настройка

Добавление RevitAPIStubs

Скачайте архив с RevitAPIStubs по ссылке. В этом архиве находится python код, который помогает PyCharm делать подсказки по API Revit.

Распакуйте содержимое архива. Папки common и revit:

Добавление интерпретаторов

Перед тем, как добавлять интерпретаторы, убедитесь, что на вашем ПК установлена сама платформа Bim4Everyone.

В главном окне при запуске PyCharm перейдите в раздел Customize -> All settings:

Затем перейдите в раздел Python Interpreter -> Show All

Нажмите + чтобы добавить интерпретатор:

В открывшемся окне выберите раздел Virtual Environment. В качестве Base interpreter укажите путь к python.exe (python2.7 который вы устанавливали выше). Т.к. stub файлы отличаются для каждой версии Revit, то нужно создать интерпретаторы под все версии Revit, которые у вас установлены, и разместить их в отдельных директориях. Директории укажите в Location.

Затем необходимо настроить пути для каждого интерпретатора. Чтобы открыть окно настроек, нажмите ПКМ на интерпретатор и выберите Show Interpreter Paths:

Для каждого добавленного интерпретатора необходимо добавить 4 пути:

путь к соответствующим stubs файлам из архива, находящимся в revit/20xx (будет разный для каждого интерпретатора).
путь к common файлам также из архива (будет одинаковый для всех интерпретаторов).
путь к папке %AppData%\pyRevit-Master\pyrevitlib (будет одинаковый для всех интерпретаторов), которая создается при установке pyRevit.
путь к папке %AppData%\pyRevit\Extensions\BIM4Everyone.lib (будет одинаковый для всех интерпретаторов), которая создается при установке платформы Bim4Everyone.

PyCharm custom properties

Перейдите в раздел Edit Custom Properties:

И замените весь существующий текст на следующий:

#---------------------------------------------------------------------
# Maximum file size (kilobytes) IDE should provide code assistance for.
# The larger file is the slower its editor works and higher overall system memory requirements are
# if code assistance is enabled. Remove this property or set to very large number if you need
# code assistance for any files available regardless their size.
#---------------------------------------------------------------------
idea.max.intellisense.filesize=40000

#---------------------------------------------------------------------
# Maximum file size (kilobytes) IDE is able to open.
#---------------------------------------------------------------------
idea.max.content.load.filesize=40000

2.4 - Плагины для Autodesk Revit

Руководство по установке плагинов для Autodesk Revit, помогающих в разработке на платформе.

В разработке плагинов для платформы очень помогают существующие плагины от других разработчиков. На данной странице приведены самые полезные из них.

RevitLookup

RevitLookup предоставляет широкие возможности для просмотра и навигации по API объектам в Revit.

Установка

Перейдите на страницу релизов и скачайте установочные файлы для каждой версии Revit, которая у вас установлена. Запустите установочные файлы и следуйте инструкциям по установке.

RevitAddInManager

RevitAddInManager позволяет запускать собранные dll плагинов для их дальнейшей отладки в IDE.

Установка

Перейдите на страницу релизов и скачайте последнюю версию установочного файла. Запустите его и следуйте инструкциям по установке.