diff --git a/docs/source/basic_setup.md b/docs/source/basic_setup.md index 2b649d95..246319a2 100644 --- a/docs/source/basic_setup.md +++ b/docs/source/basic_setup.md @@ -1,11 +1,20 @@ ### [Go Back](./index.md#table-of-contents) +# Basic Setup This page shows the basic setup for using OpenRAM. -# Basic Setup + + +## Table of Contents +1. [Dependencies](#dependencies) +1. [OpenRAM Library](#openram-library) +1. [Docker](#docker) +1. [Environment](#environment) +1. [Sky130 Setup](#sky130-setup) + + ## Dependencies - Please see the Dockerfile for the required versions of tools. In general, the OpenRAM compiler has very few dependencies: @@ -26,14 +35,14 @@ git clone git@github.com:VLSIDA/OpenRAM.git cd OpenRAM make library ``` + + Install the latest _dev_ version: ``` -pip3 install git+ssh://git@github.com/VLSIDA/OpenramRAM.git@dev +pip3 install git+ssh://git@github.com/VLSIDA/OpenRAM.git@dev ``` ## Docker - We have a [docker setup](../../docker) to run OpenRAM. To use this, you should run: ``` cd OpenRAM/docker diff --git a/docs/source/basic_usage.md b/docs/source/basic_usage.md index d8bc9778..1bebd2b8 100644 --- a/docs/source/basic_usage.md +++ b/docs/source/basic_usage.md @@ -34,17 +34,19 @@ This page of the documentation explains the basic usage of OpenRAM. If you have the library installed, you can use OpenRAM in any Python script. You can import "openram" as follows: ```python import openram -import globals -globals.init_openram("myconfig.py") # Config files are explained on this page +openram.init_openram("myconfig.py") # Config files are explained on this page +# Now you can use modules from openram +from openram import tech +... ``` -Note that you should import "openram" in this order so that the modules are imported properly. You can also look +Note that you should need to initalize OpenRAM so that the modules are imported properly. You can also look at [sram_compiler.py](../../sram_compiler.py) as an example on how to use "openram." ## Command Line Usage (with library) -You can run OpenRAM from the command line using the `sram_compiler.py` script that is included in the -library's installation. You can find the package directory on a path like: +You can run OpenRAM from the command line using the [sram_compiler.py](../../sram_compiler.py) script that is +included in the library's installation. You can find the package directory on a path like: ``` /home/mrg/.local/lib/python3.8/site-packages/openram ```