Giter Club home page Giter Club logo

complex-linear-network-analyzer's Introduction

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

complex-linear-network-analyzer's People

Contributors

arfon avatar imgbotapp avatar pstrk avatar stevemar avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.