Skip to content
This repository has been archived by the owner on Jul 22, 2024. It is now read-only.

IBM/complex-linear-network-analyzer

Repository files navigation

Complex Linear Network Analyzer (COLNA)

The complex linear network analyzer (COLNA) python package analytically computes the propagation of complex valued signals in networks with linear nodes and directed, complex valued and delayed edges.

  • COLNA can be used to model linear, photonic circuits (e.g. Si photonic integrated circuits). It provides an analytic expression of the systems transfer matrix, which is often useful to better understand the effect of system parameters on the output signal.

  • COLNA offers an easy and well documented interface, which allows to quickly build network models and understand their behaviour.

  • COLNA computes all paths leading from input to output nodes down to a certain amplitude accuracy threshold. It also supports the evaluation of recurrent paths (loops).

  • COLNA supports the mixed use of numeric and symbolic numbers (variable) for all edge properties.

  • COLNA can inject complex valued signals to the network and the compute the resulting signals at the output nodes using a testbench.

  • COLNA was developed to compute coherent wave propagation in linear photonic circuits but it can be used in other areas, where signal propagation through linear complex valued networks is of relevance.

  • COLNA is well suited for educational purposes, where analytic expression help to better understand the functionality of simple photonic networks, like for example a Mach-Zehnder interferometer.

The core functionality of COLNA is visualized in the figure below.

Documentation

Documentation including a full reference, tutorials and examples is available here.

Installation

Pip install the COLNA package. All required packages are installed automatically.

pip install complex-linear-network-analyzer

If you intend to use the visualization feature, Graphviz must be installed and added to the path and the COLNA package must be installed as follows:

pip install complex-linear-network-analyzer[Visualization]

Details for the installation are given in the user manual.

Requirements

Numpy, Scipy, Matplotlib, tqdm

For visualization: Graphviz + Graphviz Python Package (see installation instructions for details)

Contributing

Contributions are very welcome! Please follow the the contribution guidelines.

Paper and Citation

A short paper on COLNA has been published in the Journal of Open Source Software (JOSS): DOI

If COLNA was useful for your work please consider citing the JOSS article.

Citation String Stark et al., (2020). COLNA: A Python Package to Analyze Complex, Linear Networks. Journal of Open Source Software, 5(46), 2073, https://doi.org/10.21105/joss.02073

Bibtex Citation

@article{Stark2020,
  doi = {10.21105/joss.02073},
  url = {https://doi.org/10.21105/joss.02073},
  year = {2020},
  publisher = {The Open Journal},
  volume = {5},
  number = {46},
  pages = {2073},
  author = {Pascal Stark and Lorenz Müller},
  title = {COLNA: A Python Package to Analyze Complex, Linear Networks},
  journal = {Journal of Open Source Software}
}

Authors and Maintainers

  • Pascal Stark
  • Lorenz Müller