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
To start the project you need to first create an empty Git project on Github and make sure your repo is public and includes a README
Open your Terminal. Create an empty folder to use as your Caravel workspace, and navigate to it.
# Create a directory and call it anything you want
mkdir -p caravel_tutorial
# navigate into the directorycd caravel_tutorial
Clone caravel_user_project and setup the git environment as follows
# Make sure that ``caravel_example`` matches the empty github repo name in step 1
git clone -b mpw-5a https://github.com/efabless/caravel_user_project caravel_example
cd caravel_example
git remote rename origin upstream
# You need to put your empty github repo URL from step 1
git remote add origin <your github repo URL># Create a new branch, you can name it anything
git checkout -b <my_branch>
git push -u origin <my_branch>
Now that your git environment is setup, it's time to setup your local environment. (NOTE: docker is a prerequisite to setting up your environment)
# to install caravel-lite into your caravel_user_project# you can install full caravel (not recommended) use ``export CARAVEL_LITE=0``
make install
# To install the management core for simulation
make install_mcw
# Install openlane for hardening your project# make sure to change <directory_name> with the directory you created in step 1# in this case it is caravel_tutorialexport OPENLANE_ROOT=~/<directory_name>/openlane # you need to export this whenever you start a new shell
make openlane
# Build the pdk# make sure to change <directory_name> with the directory you created in step 1# in this case it is caravel_tutorialexport PDK_ROOT=~/<directory_name>/pdks # you need to export this whenever you start a new shell
make pdk
Now you can start hardening your design, for example
make user_proj_example
make user_project_wrapper
To run simulation on your design
make simenv
# you can run RTL/GL simulations by usingexport SIM=RTL
# ORexport SIM=GL
# you can then run the simulations using
make verify-<testbench-name># for example
make verify-io_ports
To run the precheck locally
make precheck
make run-precheck
You are done! now go to www.efabless.com to submit your project!