tutorial?

[joamatab]

Any plans for writing a documentation page or tutorial?

we would like to integrate with gdsfactory as a plugin as well

https://github.com/gdsfactory/gdsfactory/issues/1601

[edsonportosilva]

Hello @joamatab!

Regarding your questions:

1. Yes, we would like to have a documentation page for OptiCommPy. As always, our problem is free time to do it. As you know, the code is basically maintained by me and @adophobr. We currently have quite a busy schedule with teaching and other activities at our university. So, it is a slow process of getting things on track with OptiCommPy. The documentation page, in particular, is not something I have much experience in doing. I have tried looking into possible ways to do it, but the most common requires getting used to tools like https://www.sphinx-doc.org/ and so on. If you know someone already experienced and willing to give a kickstart for this task, let me know.

2. Tutorials: there are already a few examples in the example folder of how to use the OptiCommPy in optical communication systems simulations. Perhaps we can improve a few of those examples by making them more "tutorial-like".

3. About the gdsfactory plugin: yes, it would be quite nice. However, we need to agree on what exact kind of simulations would make sense. OptiCommPy is meant to be a systems simulator more than a device simulator. So, to integrate it with gdsfactory, we need to discuss what makes sense. If it is importing parameters from a gds device, such as the S-parameters, to a generic gds-device block in OptiCommPy and running simulations on it, or if you want OptiCommPy to be used in simulations that are done within gdsfactory.

What do you think?

[joamatab]

Hi Edson,

1. we can help with that
2. Sounds good to me
3. Once we work on 1-2 maybe i can give a better answer on possible synergies :)

[edsonportosilva]

The first release of a documentation page: https://opticommpy.readthedocs.io/en/latest/index.html