Get started with Open Design

Install the engineering beta, connect your AI account, and try a supported workflow on a copy of a project.

1. Check your setup

  • A Windows computer with Autodesk Revit installed.
  • A working pyRevit installation. pyRevit 7 is the intended setup; compatibility with your exact Revit and pyRevit versions still needs verification.
  • A copy of a project for evaluation. This beta has not completed release-level testing inside Revit.
  • Internet access and your own Anthropic API key for conversational AI. Anthropic usage is billed separately; credits are not included.

The current download is a ZIP package with an installation launcher, not a signed Windows Setup application. You do not need to build the optional developer components to install the pyRevit panel.

2. Install

  1. Download the beta ZIP from the Download page.
  2. Close every Revit window.
  3. Extract the entire ZIP into a normal folder on your computer.
  4. Open the extracted OpenDesign folder and double-click Install-OpenDesign.cmd.
  5. Read the installation result. If it reports an error, stop and contact support rather than assuming installation succeeded.
  6. Restart Revit and open Open Design → Design.

The installer checks the package files and preserves a previous installation when present. Keep the backup until you have verified the new version. The standard per-user extension folder does not require administrator privileges.

3. Connect conversational AI

Open Settings in Open Design and configure your Anthropic API key. Do not edit source files or share your key in a support message. AI requests may send your prompt and selected model context to the provider; only use project information you are authorized to share.

4. Try your first task

  1. Open a copy of a small project with known rooms and elements.
  2. Open the Design panel and inspect Model Info. Compare the displayed information with your project.
  3. Try a supported task. Review its assumptions and any proposed changes before applying them.
  4. Inspect the result in Revit and confirm that undo works as expected.

Start with electrical evaluation. Mechanical, plumbing, and fire-protection workflows still require live-project validation. All design output needs professional review.

5. Update or remove the ZIP installation

To update, close Revit and run the installer from the new fully extracted package. Keep the preserved previous version until the update has been checked.

To remove this ZIP installation, close Revit and move SmartMEP.extension out of every registered pyRevit extension folder. Restart Revit. Do not delete your project files or credentials.

To restore a previous version, first move the current extension out of the registered folder, then rename the preserved backup to SmartMEP.extension. Keep only one active copy in your registered extension folders.

Custom extension folders

If your organization uses a custom pyRevit extension folder, ask your BIM administrator to confirm the correct location. Run the PowerShell installer with the -ExtensionDir option for that folder. The installer does not change your pyRevit configuration.

Example: powershell -NoProfile -ExecutionPolicy Bypass -File .\Install-OpenDesign.ps1 -ExtensionDir "D:\Your Extensions"

This execution-policy option applies only to that PowerShell process. Follow your organization’s software-installation policy.

Need help?

Use the Support page for installation help or unexpected results. Include your Revit version, pyRevit version, download date, and the error message. Never include API keys or confidential project files.

Download · Getting started · Known limitations · Get support