.. openepda documentation master file, created by
   sphinx-quickstart on Sun Nov  4 02:02:22 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

=================
openEPDA Overview
=================

About openEPDA
==============

openEPDA™ is a collection of open standards to be used in electronic-photonic
design automation. These include definition of data interchange formats to
facilitate Foundry PDK distribution and
easier simulation and measurement data exchange between the parties involved
in the PIC design chain.

openEPDA structure
------------------
openEPDA standards are split in three parts based on their target usage
in EPDA:

1. ::General purpose standards

   These standards are intended to be used for multiple purposes in both
   PDK and measurement / simulation definitions.

   a. data serialization format (:ref:`openepda_data_format`);
   b. analytic expression format (:ref:`analytic_expressions`);
   c. vocabulary of standard terms (*under development*).

2. Foundry PDK

   These standards cover the data to be provided by the foundries for PDK
   definition.

   a. foundry technology including mask layers, cross-sections (*under development*);
   b. foundry building blocks (:ref:`pdk_components`);
   c. standard interconnects (:ref:`openepda_interconnects`).


3. Measurement / circuit simulation definitions

   a. chip description (:ref:`openepda_cdf_format`);
   b. netlist format (*under development*);
   c. measurement description (:ref:`openepda_mdf_format`);
   d. equipment API for python (*under development*).


Reference implementation
------------------------
We have developed an `openepda <https://pypi.org/project/openepda/>`_
python package, which includes validators for the above formats, as well as
file readers / writers.


Authors
=======

.. _authors:

openEPDA is a trademark of TU/e and PITC. openEPDA is maintained by TU/e and
PITC. The full list of contributors is listed on the :ref:`about` page.
Authors and copyright for specific standards are provided on the
corresponding pages.

.. toctree::
   :hidden:
   :caption: Overview

   about
   licensing_policy
   contributing
   pypi_package/history_of_changes

.. toctree::
   :caption: Standards - general
   :maxdepth: 2

   general_standards_overview
   data/openepda_data_format
   analytic_expressions

.. toctree::
   :caption: Standards - PDK
   :maxdepth: 2

   pdk_standards_overview
   updk/pdk_components
   interconnect/interconnects


.. toctree::
   :caption: Standards - Testing
   :maxdepth: 2

   testing_standards_overview
   cdf/openepda_cdf_format
   mdf/openepda_mdf_format

.. toctree::
   :hidden:
   :caption: Other resources

   openepda on pypi <https://pypi.org/project/openepda/>
   openEPDA Validation <https://validate.openepda.org>