Skip to content
Snippets Groups Projects
Commit 80b6affa authored by Oscar Gustafsson's avatar Oscar Gustafsson :bicyclist:
Browse files

Add text to the first doc page

parent 9deafbbd
No related branches found
No related tags found
1 merge request!267Add text to the first doc page
Pipeline #93372 failed
...@@ -6,6 +6,46 @@ ...@@ -6,6 +6,46 @@
Welcome to B-ASIC's documentation! Welcome to B-ASIC's documentation!
================================== ==================================
B-ASIC is a toolbox for Python 3 that simplifies implementing application-specific
circuits, primarily aimed at signal processing algorithms for both standard-cell and
FPGA technology.
It was initially developed by a group of students to replace an existing Matlab
toolbox in a course commonly referred to as "the ASIC course" at
`Division of Computer Engineering <https://liu.se/en/organisation/liu/isy/da>`_,
`Linköping University <https://liu.se/>`_, Sweden.
Hence, the name "Better ASIC toolbox" = B-ASIC.
It was initiated and is currently maintained by
`Oscar Gustafsson <https://liu.se/en/employee/oscgu95>`_.
The development of B-ASIC happens at
`https://gitlab.liu.se/da/B-ASIC <https://gitlab.liu.se/da/B-ASIC>`_.
It is not yet fully functional, but several parts of the design flow works,
while others are missing/buggy. The goal is to have a working design path from
algorithm downto a HDL-description of a custom architecture. Once it becomes a
bit more mature, we expect to make it available on pypi and conda-forge so
that it will becomes easier to access.
To install B-ASIC, the currently preferred way is::
git clone https://gitlab.liu.se/da/B-ASIC.git
cd B-ASIC
python -m pip install -e .
This will install in editable mode, which is beneficial since you then easily
can pull new changes without having to reinstall it. It also makes it easy to contribute
any improvements.
In addition to the dependencies that are automatically installed, you will also
need a Qt-binding, but you are free to choose from the available Qt5 and Qt6 bindings.
See `https://gitlab.liu.se/da/B-ASIC <https://gitlab.liu.se/da/B-ASIC>`_ for more info.
If you use B-ASIC in a publication, please acknowledge it. Later on there will be a
citation provided, but right now, please refer to this documentation or the repository.
We will also maintain a list of publications that have used B-ASIC.
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Contents: :caption: Contents:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment