COLNA
COLNA: A Python Package to Analyze Complex, Linear Networks - Published in JOSS (2020)
Science Score: 93.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
✓DOI references
Found 9 DOI reference(s) in README and JOSS metadata -
✓Academic publication links
Links to: joss.theoj.org -
○Committers with academic emails
-
○Institutional organization owner
-
✓JOSS paper metadata
Published in Journal of Open Source Software
Scientific Fields
Repository
Computes analytically the output of complex valued, linear networks.
Basic Info
- Host: GitHub
- Owner: IBM
- License: apache-2.0
- Language: Python
- Default Branch: master
- Homepage: https://ibm.github.io/complex-linear-network-analyzer/
- Size: 7.21 MB
Statistics
- Stars: 6
- Watchers: 6
- Forks: 5
- Open Issues: 4
- Releases: 3
Metadata Files
README.md
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):
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
Owner
- Name: International Business Machines
- Login: IBM
- Kind: organization
- Email: awesome@ibm.com
- Location: United States of America
- Website: https://www.ibm.com/opensource/
- Twitter: ibmdeveloper
- Repositories: 3,152
- Profile: https://github.com/IBM
JOSS Publication
COLNA: A Python Package to Analyze Complex, Linear Networks
Authors
IBM Research – Zürich, Säumerstrasse 4, 8803 Rüschlikon, Switzerland
IBM Research – Zürich, Säumerstrasse 4, 8803 Rüschlikon, Switzerland
Editor
Arfon Smith
Tags
Photonic networks Integrated Photonics Complex networks Simulation Circuit Simulation Photonic CircuitsGitHub Events
Total
Last Year
Committers
Last synced: 7 months ago
Top Committers
| Name | Commits | |
|---|---|---|
| Pascal Stark | C****K@z****m | 68 |
| Pascal Stark | 3****k | 3 |
| ImgBotApp | I****p@g****m | 2 |
| Steve Martinelli | 4****r | 1 |
| Arfon Smith | a****n | 1 |
| Lorenz K. Muller | l****u@z****m | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 6
- Total pull requests: 16
- Average time to close issues: 11 days
- Average time to close pull requests: about 10 hours
- Total issue authors: 2
- Total pull request authors: 3
- Average comments per issue: 0.33
- Average comments per pull request: 0.06
- Merged pull requests: 14
- Bot issues: 0
- Bot pull requests: 4
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- pstrk (5)
- brandondube (1)
Pull Request Authors
- pstrk (11)
- imgbot[bot] (4)
- arfon (1)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 34 last-month
- Total dependent packages: 0
- Total dependent repositories: 1
- Total versions: 4
- Total maintainers: 1
pypi.org: complex-linear-network-analyzer
Computes analytically the output of complex valued, linear networks.
- Homepage: https://github.com/IBM/complex-linear-network-analyzer
- Documentation: https://complex-linear-network-analyzer.readthedocs.io/
- License: Apache Software License
-
Latest release: 1.0.4
published about 6 years ago
Rankings
Maintainers (1)
Dependencies
- matplotlib *
- numpy *
- scipy *
- tqdm *