You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Documentation clarifications in basic_usage and basic_setup #262
Hi everyone. I'm starting to work with OpenRAM and I think it's a great project. I had a few confusions I'd like to post here in case others got stuck like I did.
I think the directory names have changed, I needed to set OPENRAM_HOME to export OPENRAM_HOME="path/to/OpenRAM/compiler" (the capitalization is off, the info is correct in basic_setup.md however)
Moreover, it wasn't immediately clear to me how to get the python environment working - I think miniconda/anaconda caused more problems than it fixed. Might I suggest also recommending using venv in basic_setup.md as follows?
(as a MacOS/homebrew user, trying to do anything with the local pip3 command ends up being more annoying and I've had better luck with venv versus Anaconda or the system pip).
Another small documentation clarification: to pass arguments into the macros Makefile, one needs to pass, e.g., make OPENRAM_OPTS=-n example_config_scn4m_subm.
Thanks for the suggestions. If you could make specific commit changes, I can merge them in. However, nobody is really funded to maintain openram at the moment, so this will like sit for a while.
Still open, and a documentation PR is the quickest path. docs/source/basic_usage.md and basic_setup.md are both plain Markdown, so the clarifications you listed can go straight in.
If you would like to take it, a PR against dev would be very welcome and we will review and consider it — see CONTRIBUTING.md. Contributions go to the dev branch, and the regression suite is run with cd compiler/tests && make -k -j<N>.
Activity
mguthaus commentedon Feb 26, 2025
Hi Sam,
Thanks for the suggestions. If you could make specific commit changes, I can merge them in. However, nobody is really funded to maintain openram at the moment, so this will like sit for a while.
mguthaus commentedon Oct 13, 2026
Still open, and a documentation PR is the quickest path.
docs/source/basic_usage.mdandbasic_setup.mdare both plain Markdown, so the clarifications you listed can go straight in.If you would like to take it, a PR against
devwould be very welcome and we will review and consider it — see CONTRIBUTING.md. Contributions go to thedevbranch, and the regression suite is run withcd compiler/tests && make -k -j<N>.