luke
/
OpenRAM
mirror of https://github.com/VLSIDA/OpenRAM.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update documentation of library usage

This commit is contained in:
Eren Dogan 2022-12-02 22:34:11 -08:00
parent fe81bbfd7e
commit 1a621cf41d
1 changed files with 4 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/source/basic_usage.md
View File

@ -40,19 +40,18 @@ from openram import tech
... ...
``` ```
Note that you should need to initalize OpenRAM so that the modules are imported properly. You can also look Note that you 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." at [sram_compiler.py](../../sram_compiler.py) as an example on how to use "openram."
If you want to pass custom configuration when generating an SRAM, you can use `sram_config` class. If you want to pass custom configuration when generating an SRAM, you can use the `sram_config` class.
```python ```python
import openram import openram
openram.init_openram("myconfig.py") openram.init_openram("myconfig.py")
openram.setup_bitcell()
from openram.modules import sram_config from openram import sram_config
c = sram_config(...) c = sram_config(...)
from openram.modules import sram from openram import sram
s = sram(sram_config=c, s = sram(sram_config=c,
name="custom_name") name="custom_name")