diff --git a/README.rst b/README.rst index ddb1159b..38c76d31 100644 --- a/README.rst +++ b/README.rst @@ -1,72 +1 @@ -**P**\hotonic **I**\ntegrated **EL**\ectronics -=============================================== - -|PyPI Name| |PyPI Version| |Build Status| |Documentation Status| |MIT| |Black| - -Microservices to codesign photonics, electronics, communications, -quantum, and more. - -- Free software: MIT license -- Documentation: https://piel.readthedocs.io - -Target functionality --------------------- - -- Co-simulation and optimisation between integrated photonic and - electronic chip design. -- System interconnection modelling in multiple domains. -- Chip and interposer design integration. -- Component models translation library between simulation tools. -- Quantum models of physical circuitry. - -``piel`` aims to provide an integrated workflow to co-design photonics -and electronics, classically and quantum. It does not aim to replace the -individual functionality of each design tool, but rather provide a glue -to easily connect them all together and extract the system performance. - -Examples --------- - -Follow the many `examples in the documentation `__. - -Microservices Toolset ---------------------- - -This package provides interconnection functions to easily co-design -microelectronics through the functionality of the -`IIC-OSIC-TOOLS `__ and -photonics via `GDSFactory `__. - -.. image:: docs/_static/img/piel_microservice_structure.png - -Some existing microservice dependency integrations are: - -* `cocotb `__ - a coroutine based cosimulation library for writing VHDL and Verilog testbenches in Python. -* `hdl21 `__ - Analog Hardware Description Library in Python -* `GDSFactory `__ - An open source platform for end to-end photonic chip design and validation -* `OpenLane v1 `__ - an automated RTL to GDSII flow based on several components including OpenROAD, Yosys, Magic, Netgen and custom methodology scripts for design exploration and optimization -* `sax `__ - S-parameter based frequency domain circuit simulations and optimizations using JAX. -* `thewalrus `__ -A library for the calculation of hafnians, Hermite polynomials and Gaussian boson sampling. -* `qutip `__ - QuTiP: Quantum Toolbox in Python - -Contribution ------------- - -If you feel dedicated enough to become a project maintainer, or just -want to do a single contribution, let's do this together! - - -.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg - :target: https://github.com/psf/black -.. |Build Status| image:: https://img.shields.io/travis/daquintero/piel.svg - :target: https://travis-ci.com/daquintero/piel -.. |Documentation Status| image:: https://readthedocs.org/projects/piel/badge/?version=latest - :target: https://piel.readthedocs.io/en/latest/?version=latest -.. |MIT| image:: https://img.shields.io/github/license/gdsfactory/gdsfactory - :target: https://choosealicense.com/licenses/mit/ -.. |PyPI Name| image:: https://img.shields.io/badge/pypi-piel-blue - :target: https://pypi.python.org/pypi/piel -.. |PyPI Version| image:: https://img.shields.io/pypi/v/piel.svg - :target: https://pypi.python.org/pypi/piel -.. |Updates| image:: https://pyup.io/repos/github/daquintero/piel/shield.svg - :target: https://pyup.io/repos/github/daquintero/piel/ +.. include:: docs/README.rst diff --git a/docs/README.rst b/docs/README.rst new file mode 100644 index 00000000..fa7b0309 --- /dev/null +++ b/docs/README.rst @@ -0,0 +1,72 @@ +**P**\hotonic **I**\ntegrated **EL**\ectronics +=============================================== + +|PyPI Name| |PyPI Version| |Build Status| |Documentation Status| |MIT| |Black| + +Microservices to codesign photonics, electronics, communications, +quantum, and more. + +- Free software: MIT license +- Documentation: https://piel.readthedocs.io + +Target functionality +-------------------- + +- Co-simulation and optimisation between integrated photonic and + electronic chip design. +- System interconnection modelling in multiple domains. +- Chip and interposer design integration. +- Component models translation library between simulation tools. +- Quantum models of physical circuitry. + +``piel`` aims to provide an integrated workflow to co-design photonics +and electronics, classically and quantum. It does not aim to replace the +individual functionality of each design tool, but rather provide a glue +to easily connect them all together and extract the system performance. + +Examples +-------- + +Follow the many `examples in the documentation `__. + +Microservices Toolset +--------------------- + +This package provides interconnection functions to easily co-design +microelectronics through the functionality of the +`IIC-OSIC-TOOLS `__ and +photonics via `GDSFactory `__. + +.. image:: _static/img/piel_microservice_structure.png + +Some existing microservice dependency integrations are: + +* `cocotb `__ - a coroutine based cosimulation library for writing VHDL and Verilog testbenches in Python. +* `hdl21 `__ - Analog Hardware Description Library in Python +* `GDSFactory `__ - An open source platform for end to-end photonic chip design and validation +* `OpenLane v1 `__ - an automated RTL to GDSII flow based on several components including OpenROAD, Yosys, Magic, Netgen and custom methodology scripts for design exploration and optimization +* `sax `__ - S-parameter based frequency domain circuit simulations and optimizations using JAX. +* `thewalrus `__ -A library for the calculation of hafnians, Hermite polynomials and Gaussian boson sampling. +* `qutip `__ - QuTiP: Quantum Toolbox in Python + +Contribution +------------ + +If you feel dedicated enough to become a project maintainer, or just +want to do a single contribution, let's do this together! + + +.. |Black| image:: https://img.shields.io/badge/code%20style-black-000000.svg + :target: https://github.com/psf/black +.. |Build Status| image:: https://img.shields.io/travis/daquintero/piel.svg + :target: https://travis-ci.com/daquintero/piel +.. |Documentation Status| image:: https://readthedocs.org/projects/piel/badge/?version=latest + :target: https://piel.readthedocs.io/en/latest/?version=latest +.. |MIT| image:: https://img.shields.io/github/license/gdsfactory/gdsfactory + :target: https://choosealicense.com/licenses/mit/ +.. |PyPI Name| image:: https://img.shields.io/badge/pypi-piel-blue + :target: https://pypi.python.org/pypi/piel +.. |PyPI Version| image:: https://img.shields.io/pypi/v/piel.svg + :target: https://pypi.python.org/pypi/piel +.. |Updates| image:: https://pyup.io/repos/github/daquintero/piel/shield.svg + :target: https://pyup.io/repos/github/daquintero/piel/ diff --git a/docs/index.rst b/docs/index.rst index bb58d9a7..86fe4552 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,6 +1,6 @@ .. _readme: -.. include:: ../README.rst +.. include:: README.rst Contents