py-fmas

py-fmas is a Python package for the accurate numerical simulation of the z-propagation dynamics of ultrashort optical pulses in single mode nonlinear waveguides. The simulation approach is based on propagation models for the analytic signal of the optical field.

The software implements various models of the Raman response and allows to calculate spectrograms, detailing the time-frequency composition of the analytic signal. Additionally, a convenience class for analyzing propagation constants is provided.

Further details can be found on the py-fmas project page.

Installation

The software can be installed by cloning the repository and installing the provided Python3 wheel in the following way

$ git clone https://github.com/omelchert/py-fmas.git
$ cd ./py-fmas/dist 
$ python3 -m pip install py_fmas-1.0-py3-none-any.whl

Further information

• Project page: https://omelchert.github.io/py-fmas/

• Source: https://github.com/omelchert/py-fmas

• Extended user guide: https://omelchert.github.io/py-fmas/auto_tutorials/index.html

• Examples gallery: https://omelchert.github.io/py-fmas/auto_examples/index.html

• Reference manual: https://omelchert.github.io/py-fmas/reference_manual/index.html

• Citations: https://omelchert.github.io/py-fmas/citations.html

License

This project is licensed under the MIT License - see the LICENSE.md file for details.