Contents Menu Expand Light mode Dark mode Auto light/dark mode
OpenLane Documentation
OpenLane Documentation
  • Getting Started
    • Migrating from OpenLane 1
      • Variable Migration Guides
    • Newcomers
    • Installation Overview
    • Nix-based Installation
      • Windows 10+
      • macOS 11+
      • Ubuntu/Other Linux
    • Docker-based Installation
      • Windows 10+
      • macOS 11+
      • Ubuntu 20.04+
      • Other Linux
  • Usage Guides
    • Power Distribution Networks
    • Using PDKs
    • Timing Corners
    • Achieving Timing Closure
    • Using Macros
    • Tutorial: Implementing a Macro for Caravel
    • Writing Custom Flows
    • Writing Custom Steps
    • Writing and Using Plugins
  • Reference Manual
    • Design Configuration Files
    • Built-in Flows and their Configuration Variables
      • Universal Flow Configuration Variables
      • Universal Flow PDK Configuration Variables
    • Built-in Steps and their Configuration Variables
    • Pin Placer Configuration Files
    • Architectural Overview
    • openlane API
      • openlane.common API
        • openlane.common.metrics API
      • openlane.config API
      • openlane.flows API
      • openlane.logging API
      • openlane.state API
      • openlane.steps API
  • Additional Material
  • Glossary
  • Frequently-Asked Questions (FAQ)
  • Notes for Contributors
    • Contributing Code
    • Contributing Docs
    • CI Documentation
    • Class Programming Guidelines
    • Updating Tools
Back to top
Edit this page

Getting Started¶

Before we get started, please pick one of these two options…

I am new to OpenLane

I have previously used OpenLane 1

Just show me installation instructions.

Next Steps¶

After you get started, we recommend this tutorial next:

  • Tutorial: Implementing a Macro for Caravel

Next
Migrating from OpenLane 1
Previous
Home
Copyright © 2020-2025 Efabless Corporation and contributors
Made with Sphinx and @pradyunsg's Furo
On this page
  • Getting Started
    • Next Steps