Archicad Python API - Quickstart & More Operations

This repository contains Jupyter notebooks demonstrating how to interact with Archicad using its Python API. The notebooks provide a step-by-step guide to setting up the environment, establishing a connection, and performing various operations within Archicad.

Contents

1. archic_api_python_quickstart.ipynb

• Introduction: Provides an overview of the Archicad Python API with useful documentation links.
• Setup: Guides users on obtaining the necessary project files and preparing the scripting environment.
• Basic Scripting: Demonstrates how to:
  • Connect to Archicad using the ACConnection module.
  • Establish communication with an open project.
  • Perform simple commands, such as checking if the connection is active.

2. archicad_api_more_operations.ipynb

• Advanced API Operations: Explores more complex Archicad Python API functionalities.
• Navigator Item Operations:
  • Retrieves and manipulates Navigator Trees like Project Map, View Map, and Layout Book.
  • Executes API commands to interact with Archicad’s internal structure.

Prerequisites

• Archicad installed and running.
• Python environment with archicad package installed.
• Jupyter Notebook (recommended) or any preferred IDE.

Getting Started

1. Open Archicad and load the required .pln project.
2. Run the Jupyter Notebook to establish a connection.
3. Execute the provided scripts to interact with Archicad.

Useful Links

• Archicad Python Package
• API Reference Manual
• JSON Interface Documentation
• Graphisoft Official Python API Page