search

idea-fasoc / OpenFASOC

Fully Open Source FASOC generators built on top of open-source EDA tools
https://openfasoc.readthedocs.io
Apache License 2.0
216 stars 90 forks source link

readme

OpenFASoC

OpenFASoC: Fully Open-Source Autonomous SoC Synthesis using Customizable Cell-Based Synthesizable Analog Circuits

.. image:: https://readthedocs.org/projects/openfasoc/badge/?version=latest :target: https://openfasoc.readthedocs.io/en/latest/?badge=latest

OpenFASOC is focused on open-source automated analog generation from user specification to GDSII with fully open-sourced tools. This project is led by a team of researchers at the University of Michigan and is inspired by FASoC, that sits on proprietary tools. (See more about FaSoC at website <https://fasoc.engin.umich.edu/>_)

Contact: mehdi@umich.edu

Getting Started

There are two methods to install the prerequisites to use OpenFASOC generators:

  1. Express Installation

    Install all the prerequisites using the dependencies.sh script provided in the home location of this project (where this README.rst file is found). Supports CentOS7, Ubuntu 20.04 LTS and Ubuntu 22.04 LTS.

    .. code-block:: bash

    $ sudo ./dependencies.sh

    For more info on getting-started, please refer to "Getting Started" section's express install section <https://openfasoc.readthedocs.io/en/latest/getting-started.html#express-installation>_

  2. Containerized Installation

    This method uses Docker <https://www.docker.com/#build> to build a custom image, on top of which a container is created, in which the generators can be run. This allows the user to create a persistent snapshot of an environment where are tools are installed. Note: If you do not have Docker Installed, refer to the instructions here <https://docs.docker.com/engine/install/>

    .. code-block:: bash

    $ cd docker/conda $ sudo docker build -t . $ cd ../.. $ sudo docker run -v $(pwd):$(pwd) -w $(pwd) --name -it $ pip install -r requirements.txt

    Where <image_name> is the name that you want to tag the built image with and <container_name> is the name of the container that will be run. This container will use the OpenFASOC directory as the working directory and bind mount it to the container's present working directory.

  3. Manual Install

    Below are the tool requirements along with their currently support versions that are updated regularly upon testing againsts the generators.

    1. Magic <https://github.com/RTimothyEdwards/magic>_ (version:8.3.464)

    2. Netgen <https://github.com/RTimothyEdwards/netgen>_ (version:1.5.272)

    3. Klayout <https://github.com/KLayout/klayout>_ (version:0.28.17-1)

      • Please use this command to build preferably: ./build.sh -option '-j8' -noruby -without-qt-multimedia -without-qt-xml -without-qt-svg

    4. Yosys <https://github.com/The-OpenROAD-Project/yosys>_ (version:0.38+92)

    5. OpenROAD <https://github.com/The-OpenROAD-Project/OpenROAD>_ (version:2.0_12381)

    6. Open_pdks <https://github.com/RTimothyEdwards/open_pdks>_ (version:1.0.471)

      • open_pdks is required to run drc/lvs check and the simulations
      • After open_pdks is installed, please update the open_pdks key in common/platform_config.json with the installed path, down to the sky130A folder

    7. Xyce <https://github.com/Xyce/Xyce>_ (version: 7.6)

      • Once the Xyce installation is complete, please make sure to add Xyce binary to $PATH environment variable.

    Other notice:

    • Python 3.10 is used in this generator.
    • All the required tools need to be loaded into the environment before running this generator.
    • Glayout is now available as a python package <https://pypi.org/project/glayout/>_ and can be installed using pip install glayout

Generators

.. list-table:: :widths: 30 20 20 30 :header-rows: 1

Tapeouts and testing setup

Please refer to our testing setup in our tapeouts and testing setup section <https://github.com/idea-fasoc/openfasoc-tapeouts>_.

Citation

If you find this tool useful in your research, we kindly request to cite our papers: