riscv
/
coriolis
mirror of https://gitlab.lip6.fr/vlsi-eda/coriolis.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
coriolis/README.rst

67 lines
2.0 KiB
ReStructuredText
Raw Normal View History

Added README and detection of 64 bits using /lib.
2015-04-25 11:27:04 -05:00
.. -*- Mode: rst -*-
Simplify release naming
2023-07-22 19:56:48 -05:00
|Python wheel builds|
.. |Python wheel builds| image:: https://github.com/lip6/coriolis/actions/workflows/wheels.yml/badge.svg
:target: https://github.com/lip6/coriolis/actions/workflows/wheels.yml
Build doc pelican (#11) * Switch back to a generated version of the documentation. Dependencies for the documentation generation have been added to poetry. As Pelican is a Python tool, that makes sense. Note to myself: To generate the doc with ccb.py we *need* to be inside the Python virtual env generated by Poetry. Instead of relying of a default one, provide one of our own (coriolis-venv) and make poetry run in it. * Top builder.py now generated the doc. * Forgot to remove generated PDFs in the documentation. * A bit of cleanup on the README.rst * Forgot the logo. Try to use code-block directive in README. * Still typo in the logo path. * One more trial at setting the image position. * OK. That's enough for the logo. * Problems with code-block. * Voila! * Build inside a venv and use poetry in the top level Makefile. * Remove doxygen generated docs. * More doc cleanup in oroshi.
2023-08-01 08:43:21 -05:00
.. image:: documentation/content/images/common/Coriolis-logo-blue-4.png
:alt: Coriolis Logo
:align: center
:width: 10%
Added README and detection of 64 bits using /lib.
2015-04-25 11:27:04 -05:00
Build doc pelican (#11) * Switch back to a generated version of the documentation. Dependencies for the documentation generation have been added to poetry. As Pelican is a Python tool, that makes sense. Note to myself: To generate the doc with ccb.py we *need* to be inside the Python virtual env generated by Poetry. Instead of relying of a default one, provide one of our own (coriolis-venv) and make poetry run in it. * Top builder.py now generated the doc. * Forgot to remove generated PDFs in the documentation. * A bit of cleanup on the README.rst * Forgot the logo. Try to use code-block directive in README. * Still typo in the logo path. * One more trial at setting the image position. * OK. That's enough for the logo. * Problems with code-block. * Voila! * Build inside a venv and use poetry in the top level Makefile. * Remove doxygen generated docs. * More doc cleanup in oroshi.
2023-08-01 08:43:21 -05:00
======================
Coriolis Open EDA Tool
======================
Coriolis is a free database, placement and routing tool for VLSI design.
Added README and detection of 64 bits using /lib.
2015-04-25 11:27:04 -05:00
Update repo references in code to point to github
2023-07-12 17:33:22 -05:00
This project is hosted at: https://github.com/lip6/coriolis
Update readme for new project location
2023-07-12 17:31:00 -05:00
Build doc pelican (#11) * Switch back to a generated version of the documentation. Dependencies for the documentation generation have been added to poetry. As Pelican is a Python tool, that makes sense. Note to myself: To generate the doc with ccb.py we *need* to be inside the Python virtual env generated by Poetry. Instead of relying of a default one, provide one of our own (coriolis-venv) and make poetry run in it. * Top builder.py now generated the doc. * Forgot to remove generated PDFs in the documentation. * A bit of cleanup on the README.rst * Forgot the logo. Try to use code-block directive in README. * Still typo in the logo path. * One more trial at setting the image position. * OK. That's enough for the logo. * Problems with code-block. * Voila! * Build inside a venv and use poetry in the top level Makefile. * Remove doxygen generated docs. * More doc cleanup in oroshi.
2023-08-01 08:43:21 -05:00
Main documentation is available at: https://coriolis.lip6.fr/
Fix Matrix link and add Github Discussions
2023-07-23 09:52:58 -05:00
Development discussion can be found `on our Matrix Channel <https://matrix.to/#/#coriolis:matrix.org>`_ and in our `GitHub Discussions <https://github.com/lip6/coriolis/discussions>`_.
Added README and detection of 64 bits using /lib.
2015-04-25 11:27:04 -05:00
Build doc pelican (#11) * Switch back to a generated version of the documentation. Dependencies for the documentation generation have been added to poetry. As Pelican is a Python tool, that makes sense. Note to myself: To generate the doc with ccb.py we *need* to be inside the Python virtual env generated by Poetry. Instead of relying of a default one, provide one of our own (coriolis-venv) and make poetry run in it. * Top builder.py now generated the doc. * Forgot to remove generated PDFs in the documentation. * A bit of cleanup on the README.rst * Forgot the logo. Try to use code-block directive in README. * Still typo in the logo path. * One more trial at setting the image position. * OK. That's enough for the logo. * Problems with code-block. * Voila! * Build inside a venv and use poetry in the top level Makefile. * Remove doxygen generated docs. * More doc cleanup in oroshi.
2023-08-01 08:43:21 -05:00
Coriolis is part of a set of three repositories that are closely relateds.
* Alliance
A venerable EDA toolchain, working only on symbolic layout. Some of it's
checking tools (LVS, DRC) are used for the regression tests in Alliance Check Toolkit.
https://github.com/lip6/alliance
* Alliance Check Toolkit
A wide set of examples of designs and scripts to use by Coriolis.
https://github.com/lip6/alliance-check-toolkit
Added README and detection of 64 bits using /lib.
2015-04-25 11:27:04 -05:00
Purpose
=======
Coriolis provides several tools to perform the layout of VLSI circuits. Its
Various typos correction (courtesy of G. Gouvine).
2019-07-30 06:13:57 -05:00
main components are the Hurricane database, the Etesian placer and the Katana
Added README and detection of 64 bits using /lib.
2015-04-25 11:27:04 -05:00
router, but other tools can use the Hurricane database and the parsers
provided.
Update README for pypi install
2023-10-14 17:09:57 -05:00
Coriolus can be used via both the ```cgt`` graphical tool <http://coriolis.lip6.fr/pages/users-guide.html#id24>`_ and via the `rich Python API <http://coriolis.lip6.fr/pages/python-tutorial.html>`_.
Build doc pelican (#11) * Switch back to a generated version of the documentation. Dependencies for the documentation generation have been added to poetry. As Pelican is a Python tool, that makes sense. Note to myself: To generate the doc with ccb.py we *need* to be inside the Python virtual env generated by Poetry. Instead of relying of a default one, provide one of our own (coriolis-venv) and make poetry run in it. * Top builder.py now generated the doc. * Forgot to remove generated PDFs in the documentation. * A bit of cleanup on the README.rst * Forgot the logo. Try to use code-block directive in README. * Still typo in the logo path. * One more trial at setting the image position. * OK. That's enough for the logo. * Problems with code-block. * Voila! * Build inside a venv and use poetry in the top level Makefile. * Remove doxygen generated docs. * More doc cleanup in oroshi.
2023-08-01 08:43:21 -05:00
Update README for pypi install
2023-10-14 17:09:57 -05:00
Installation
============
Added README and detection of 64 bits using /lib.
2015-04-25 11:27:04 -05:00
Update README for pypi install
2023-10-14 17:09:57 -05:00
Python 3.7 or later is required to use Coliolis. It can then be installed from `Pypi <https://pypi.org/>`_.
Added a top level Makefile to encapsulate the ./bootsrap/ccb.py call.
2015-05-09 16:11:44 -05:00
Build doc pelican (#11) * Switch back to a generated version of the documentation. Dependencies for the documentation generation have been added to poetry. As Pelican is a Python tool, that makes sense. Note to myself: To generate the doc with ccb.py we *need* to be inside the Python virtual env generated by Poetry. Instead of relying of a default one, provide one of our own (coriolis-venv) and make poetry run in it. * Top builder.py now generated the doc. * Forgot to remove generated PDFs in the documentation. * A bit of cleanup on the README.rst * Forgot the logo. Try to use code-block directive in README. * Still typo in the logo path. * One more trial at setting the image position. * OK. That's enough for the logo. * Problems with code-block. * Voila! * Build inside a venv and use poetry in the top level Makefile. * Remove doxygen generated docs. * More doc cleanup in oroshi.
2023-08-01 08:43:21 -05:00
.. code-block:: bash
Update README for pypi install
2023-10-14 17:09:57 -05:00
pip3 install coriolis-eda
Added a top level Makefile to encapsulate the ./bootsrap/ccb.py call.
2015-05-09 16:11:44 -05:00
Update README for pypi install
2023-10-14 17:09:57 -05:00
Note for Windows, we currently only support running under WSL2.
Added a top level Makefile to encapsulate the ./bootsrap/ccb.py call.
2015-05-09 16:11:44 -05:00
Update README for pypi install
2023-10-14 17:09:57 -05:00
Documentation
=============
Added README and detection of 64 bits using /lib.
2015-04-25 11:27:04 -05:00
Update README for pypi install
2023-10-14 17:09:57 -05:00
The full documentation for Coriolis can be found at http://coriolis.lip6.fr/pages/documentation.html
Added README and detection of 64 bits using /lib.
2015-04-25 11:27:04 -05:00