Tools & Structure

piel aims to provide an integrated workflow to co-design photonics and electronics. 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.

This package provides interconnection functions to easily co-design microelectronics through the functionality of multiple electronic and photonic design tools.

Project Structure

A general overview of the piel python package structure:

Contents:

• Dependency Bindings
  • Methodology
    • Integration
  • Relevant Electronic Projects
    • Selection of Python-to-HDL Flow
  • Electronic Experimental Setups Reviews
  • gdsfactory
    • piel.tools.gdsfactory
      • Submodules
        • piel.tools.gdsfactory.netlist
          • Functions
          • Module Contents
            • get_matched_ports_tuple_index()
            • get_input_ports_index()
            • get_netlist()
            • get_netlist_recursive()
      • Functions
      • Package Contents
        • get_input_ports_index()
        • get_matched_ports_tuple_index()
        • get_netlist()
        • get_netlist_recursive()
  • openlane
    • v1/v2 Migration
      • piel.tools.openlane
        • Submodules
          • piel.tools.openlane.defaults
            • Attributes
            • Module Contents
              • test_spm_open_lane_configuration
              • test_basic_open_lane_configuration_v1
              • test_basic_open_lane_configuration_v2
              • example_open_lane_configuration
          • piel.tools.openlane.migrate
            • Functions
            • Module Contents
              • get_design_from_openlane_migration()
          • piel.tools.openlane.parse
            • Submodules
              • piel.tools.openlane.parse.run_output
                • Functions
                • Module Contents
                  • filter_timing_sta_files()
                  • filter_power_sta_files()
                  • get_all_timing_sta_files()
                  • get_all_power_sta_files()
              • piel.tools.openlane.parse.sta_rpt
                • Functions
                • Module Contents
                  • calculate_max_frame_amount()
                  • calculate_propagation_delay_from_timing_data()
                  • calculate_propagation_delay_from_file()
                  • configure_timing_data_rows()
                  • configure_frame_id()
                  • filter_timing_data_by_net_name_and_type()
                  • get_frame_meta_data()
                  • get_frame_lines_data()
                  • get_frame_timing_data()
                  • get_all_timing_data_from_file()
                  • read_sta_rpt_fwf_file()
              • piel.tools.openlane.parse.utils
                • Functions
                • Module Contents
                  • contains_in_lines()
                  • create_file_lines_dataframe()
                  • get_file_line_by_keyword()
                  • read_file_lines()
            • Functions
            • Package Contents
              • filter_timing_sta_files()
              • filter_power_sta_files()
              • get_all_timing_sta_files()
              • get_all_power_sta_files()
              • calculate_max_frame_amount()
              • calculate_propagation_delay_from_file()
              • calculate_propagation_delay_from_timing_data()
              • configure_timing_data_rows()
              • configure_frame_id()
              • filter_timing_data_by_net_name_and_type()
              • get_frame_meta_data()
              • get_frame_lines_data()
              • get_frame_timing_data()
              • get_all_timing_data_from_file()
              • read_sta_rpt_fwf_file()
              • contains_in_lines()
              • create_file_lines_dataframe()
              • get_file_line_by_keyword()
              • read_file_lines()
          • piel.tools.openlane.utils
            • Functions
            • Module Contents
              • extract_datetime_from_path()
              • find_all_design_runs()
              • find_latest_design_run()
              • get_gds_path_from_design_run()
              • get_design_run_version()
              • sort_design_runs()
          • piel.tools.openlane.v1
            • Functions
            • Module Contents
              • check_config_json_exists_openlane_v1()
              • check_design_exists_openlane_v1()
              • configure_and_run_design_openlane_v1()
              • configure_flow_script_openlane_v1()
              • configure_parametric_designs_openlane_v1()
              • create_parametric_designs_openlane_v1()
              • get_latest_version_root_openlane_v1()
              • get_design_directory_from_root_openlane_v1()
              • read_configuration_openlane_v1()
              • write_configuration_openlane_v1()
          • piel.tools.openlane.v2
            • Functions
            • Module Contents
              • get_all_designs_metrics_openlane_v2()
              • read_metrics_openlane_v2()
              • run_openlane_flow()
        • Functions
        • Package Contents
          • get_design_from_openlane_migration()
          • extract_datetime_from_path()
          • find_all_design_runs()
          • find_latest_design_run()
          • get_gds_path_from_design_run()
          • get_design_run_version()
          • sort_design_runs()
          • check_config_json_exists_openlane_v1()
          • check_design_exists_openlane_v1()
          • configure_and_run_design_openlane_v1()
          • configure_parametric_designs_openlane_v1()
          • configure_flow_script_openlane_v1()
          • create_parametric_designs_openlane_v1()
          • get_design_directory_from_root_openlane_v1()
          • get_latest_version_root_openlane_v1()
          • read_configuration_openlane_v1()
          • write_configuration_openlane_v1()
          • filter_timing_sta_files()
          • filter_power_sta_files()
          • get_all_timing_sta_files()
          • get_all_power_sta_files()
          • calculate_max_frame_amount()
          • calculate_propagation_delay_from_file()
          • calculate_propagation_delay_from_timing_data()
          • configure_timing_data_rows()
          • configure_frame_id()
          • filter_timing_data_by_net_name_and_type()
          • get_frame_meta_data()
          • get_frame_lines_data()
          • get_frame_timing_data()
          • get_all_timing_data_from_file()
          • read_sta_rpt_fwf_file()
          • contains_in_lines()
          • create_file_lines_dataframe()
          • get_file_line_by_keyword()
          • read_file_lines()
          • get_all_designs_metrics_openlane_v2()
          • read_metrics_openlane_v2()
          • run_openlane_flow()
  • cocotb
    • Useful Commands
      • piel.tools.cocotb
        • Submodules
          • piel.tools.cocotb.core
            • Attributes
            • Functions
            • Module Contents
              • check_cocotb_testbench_exists()
              • configure_cocotb_simulation()
              • delete_simulation_output_files
              • run_cocotb_simulation()
          • piel.tools.cocotb.data
            • Attributes
            • Functions
            • Module Contents
              • get_simulation_output_files
              • get_simulation_output_files_from_design()
              • read_simulation_data()
              • simple_plot_simulation_data()
        • Attributes
        • Functions
        • Package Contents
          • check_cocotb_testbench_exists()
          • configure_cocotb_simulation()
          • delete_simulation_output_files
          • run_cocotb_simulation()
          • get_simulation_output_files
          • get_simulation_output_files_from_design()
          • read_simulation_data()
          • simple_plot_simulation_data()
  • sax
    • Implementation Principle
    • Pseudo-Static Active Models
      • Implementation
    • API
      • piel.tools.sax
        • Submodules
          • piel.tools.sax.netlist
            • Functions
            • Module Contents
              • address_value_dictionary_to_function_parameter_dictionary()
              • compose_recursive_instance_location()
              • get_component_instances()
              • get_netlist_instances_by_prefix()
              • get_matched_model_recursive_netlist_instances()
          • piel.tools.sax.utils
            • Attributes
            • Functions
            • Module Contents
              • get_sdense_ports_index()
              • sax_to_s_parameters_standard_matrix()
              • snet
        • Attributes
        • Functions
        • Package Contents
          • address_value_dictionary_to_function_parameter_dictionary()
          • compose_recursive_instance_location()
          • get_component_instances()
          • get_netlist_instances_by_prefix()
          • get_matched_model_recursive_netlist_instances()
          • get_sdense_ports_index()
          • sax_to_s_parameters_standard_matrix()
          • snet
  • SPICE
    • Integration Scheme
    • List of Relevant SPICE Projects
    • hdl21 Selection
• Integrations
  • Methodology
    • Microservice Architecture
• Case Study
  • cocotb - sax
  • gdsfactory - SPICE Netlist - VLSIR
    • Integration Methodology
      • LVS Tools Integration
  • qutip - sax
    • Conversion Assumptions
    • Quantum Information Basics
      • piel.integration
        • Submodules
          • piel.integration.amaranth_cocotb
            • Functions
            • Module Contents
              • create_cocotb_truth_table_verification_python_script()
          • piel.integration.amaranth_openlane
            • Functions
            • Module Contents
              • layout_truth_table_through_openlane()
              • layout_amaranth_truth_table_through_openlane()
          • piel.integration.cocotb_sax
          • piel.integration.gdsfactory_hdl21
            • Submodules
              • piel.integration.gdsfactory_hdl21.conversion
                • Functions
                • Module Contents
                  • convert_connections_to_tuples()
                  • get_matching_connections()
                  • get_matching_port_nets()
                  • gdsfactory_netlist_with_hdl21_generators()
                  • gdsfactory_netlist_to_spice_string_connectivity_netlist()
              • piel.integration.gdsfactory_hdl21.core
                • Functions
                • Module Contents
                  • gdsfactory_netlist_to_spice_netlist()
                  • construct_hdl21_module()
              • piel.integration.gdsfactory_hdl21.utils
                • Functions
                • Module Contents
                  • rename_gdsfactory_connections_to_spice()
                  • convert_tuples_to_strings()
            • Functions
            • Package Contents
              • gdsfactory_netlist_to_spice_netlist()
              • construct_hdl21_module()
              • convert_connections_to_tuples()
              • gdsfactory_netlist_to_spice_string_connectivity_netlist()
              • gdsfactory_netlist_with_hdl21_generators()
              • get_matching_connections()
              • get_matching_port_nets()
          • piel.integration.gdsfactory_openlane
            • Functions
            • Module Contents
              • create_gdsfactory_component_from_openlane()
          • piel.integration.hdl21_gdsfactory
            • Submodules
              • piel.integration.hdl21_gdsfactory.netlist
                • Attributes
                • Functions
                • Module Contents
                  • ParsedProtoVLSIR
                  • _parse_module_to_proto_dict()
                  • _parse_connections()
                  • _find_target_instance_port()
                  • _generate_top_level_connections()
                  • _find_port_connection()
                  • _extract_instance_parameters()
                  • _extract_component_name()
                  • _extract_parameter_value()
                  • _generate_raw_netlist_dict_from_proto_dict()
                  • generate_raw_netlist_dict_from_module()
                  • generate_raw_yaml_from_module()
              • piel.integration.hdl21_gdsfactory.sky130
                • Attributes
                • Functions
                • Module Contents
                  • custom_mapping_dict
                  • find_most_relevant_gds()
                  • filter_port()
                  • hdl21_module_to_schematic_editor()
            • Attributes
            • Functions
            • Package Contents
              • ParsedProtoVLSIR
              • generate_raw_netlist_dict_from_module()
              • generate_raw_yaml_from_module()
              • filter_port()
              • find_most_relevant_gds()
              • hdl21_module_to_schematic_editor()
          • piel.integration.sax_qutip
            • Functions
            • Module Contents
              • sax_to_ideal_qutip_unitary()
              • verify_sax_model_is_unitary()
          • piel.integration.sax_thewalrus
            • Functions
            • Module Contents
              • unitary_permanent()
              • sax_circuit_permanent()
          • piel.integration.signal
            • Submodules
              • piel.integration.signal.frequency
                • Submodules
                  • piel.integration.signal.frequency.convert
                    • Functions
                    • Module Contents
                      • convert_to_network_transmission()
          • piel.integration.thewalrus_qutip
            • Functions
            • Module Contents
              • fock_transition_probability_amplitude()
        • Attributes
        • Functions
        • Package Contents
          • create_cocotb_truth_table_verification_python_script()
          • layout_amaranth_truth_table_through_openlane()
          • layout_truth_table_through_openlane()
          • create_gdsfactory_component_from_openlane()
          • gdsfactory_netlist_to_spice_string_connectivity_netlist()
          • gdsfactory_netlist_to_spice_netlist()
          • gdsfactory_netlist_with_hdl21_generators()
          • get_matching_connections()
          • get_matching_port_nets()
          • construct_hdl21_module()
          • convert_connections_to_tuples()
          • filter_port()
          • find_most_relevant_gds()
          • hdl21_module_to_schematic_editor()
          • generate_raw_yaml_from_module()
          • generate_raw_netlist_dict_from_module()
          • ParsedProtoVLSIR
          • sax_circuit_permanent()
          • sax_to_s_parameters_standard_matrix()
          • sax_to_ideal_qutip_unitary()
          • verify_sax_model_is_unitary()
          • fock_transition_probability_amplitude()
          • convert_to_network_transmission()