{"id":13736751,"url":"https://github.com/omelchert/pyGLLE","last_synced_at":"2025-05-08T13:31:20.774Z","repository":{"id":59893329,"uuid":"246041810","full_name":"omelchert/pyGLLE","owner":"omelchert","description":"Python package for temporal evolution of initial conditions under the generalized Lugiato-Lefever equation","archived":false,"fork":false,"pushed_at":"2022-09-22T08:35:14.000Z","size":1789,"stargazers_count":12,"open_issues_count":0,"forks_count":10,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-04-17T01:19:04.926Z","etag":null,"topics":["computational-physics","lugiato-lefever-equation","partial-differential-equations","pseudospectral-methods","python","scientific-software"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/omelchert.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-03-09T13:23:44.000Z","updated_at":"2024-04-08T07:09:48.000Z","dependencies_parsed_at":"2022-09-24T18:13:13.778Z","dependency_job_id":null,"html_url":"https://github.com/omelchert/pyGLLE","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omelchert%2FpyGLLE","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omelchert%2FpyGLLE/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omelchert%2FpyGLLE/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/omelchert%2FpyGLLE/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/omelchert","download_url":"https://codeload.github.com/omelchert/pyGLLE/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":213758652,"owners_count":15634354,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["computational-physics","lugiato-lefever-equation","partial-differential-equations","pseudospectral-methods","python","scientific-software"],"created_at":"2024-08-03T03:01:27.894Z","updated_at":"2024-08-03T03:06:53.732Z","avatar_url":"https://github.com/omelchert.png","language":"Python","funding_links":[],"categories":["simulation"],"sub_categories":[],"readme":"# pyGLLE\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)\n\npyGLLE is a Python toolkit for simulating the propagation dynamics of\ndissipative solitons in a variant of the \n[Lugiato-Lefever equation](https://en.wikipedia.org/wiki/Lugiato–Lefever_equation) (LLE).\nIncluding dispersion terms of third and fourth order, this variant is here\nreferred to as the generalised LLE (GLLE).\n\nThe provided software implements a solver for a variant of the LLE including\ndispersion terms of third and fourth order. It also includes the functionality\nto solve for stationary solutions of the standard LLE, containing one or\nseveral localized dissipative structures.\n\n### Prerequisites\n\nThe tools provided by the `pyGLLE` package require the functionality of \n\n* numpy (\u003e=1.8.0rc1)\n* scipy (\u003e=0.13.0b1)\n\nFurther, the figure generation scripts included with the examples require the\nfuncality of\n\n* matplotlib (\u003e=1.2.1)\n\n## Included materials\n\nThe repository follows a modular structure:\n\n```\npyGLLE/\n├── LICENSE.md\n├── README.md\n├── numExp01_stationarySolution\n│   ├── data_stationary_solution\n│   ├── main_findStationarySolution.py\n│   ├── pp_figure\n│   │   ├── FIGS\n│   │   ├── generateFigure.sh\n│   │   └── main_figure_stationarySolution.py\n│   └── run.sh\n├── numExp02_propagationScenarios\n│   ├── data\n│   ├── data_stationary_solution\n│   ├── main_findStationarySolution.py\n│   ├── main_propagateInitialCondition.py\n│   ├── pp_figure_propagationScenarios\n│   │   ├── FIGS\n│   │   ├── figure_base_propagationDynamics.py\n│   │   ├── generateFigures.sh\n│   │   └── main_figure_propagationDynamics_stationarySolution.py\n│   └── run.sh\n├── scripts\n│   └── pyGLLE.py\n└── src\n    ├── data_handler.py\n    ├── solver.py\n    └── stationary_solution.py\n```\n\nSubfolder `/src` contains Python modules implementing the basic functionality of the software:\n* `data_handler.py`: provides a class, handling data accumulation and data\n* ouput. Output data is stored using the numpy native npz-format.\n* `stationary_solution.py`:\n    provides functions allowing to obtain stationary localized solution of the standard LLE.\n* `solver.py`: implements a solver for the numerical integration of the generalized LLE using a Runge-Kutta method.\n\nThe folder `/scripts` contains the main Python module implementing the\ninterface between the user supplied code and the algorithms and data structures\ncontained in the modules in folder `\\src`:\n* `pyGLLE.py`: defines the main functions `findStationarySolution` and\n    `propagateInitialCondition`.\n\nFurther, the folders `\\numExp01_stationarySolution` and\n`\\numExp02_propagationScenarios` contain scripts that implement example\nworkflows ranging from the specification of a propagation scenario to the\nvisualization of the generated raw data.\n\nThe repository further contains\n* `LICENSE`, a license file.\n* `Readme.md`, this file.\n\nFor a more detailed description of functions, defined in the above modules,\ntheir parameters and return values we refer to the example cases and\ndocumentation provided within the code.\n\n## Availability of the software\n\nThe pyGLLE software package is derived from our research software and is meant to work as a (system-)local software tool. There is no need to install it once you got a local [clone](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/cloning-a-repository) of the repository, e.g. via\n\n``$ git clone https://github.com/omelchert/pyGLLE``\n\nWe further prepared a [pyGLLE compute capsule](https://codeocean.com/capsule/e0ed77d4-9589-45b4-abc8-3b21f3ce92c8/) on [Code Ocean](https://codeocean.com), allowing to directly run and modify an exemplary simulation without the need to create a local copy of the repository. \n\n## Links\n\nThe pyGLLE software package is described in \n\n\u003e O. Melchert, A. Demircan, \"pyGLLE: A Python toolkit for solving the generalized Lugiato–Lefever equation,\" SoftwareX 15 (2021) 100741, DOI: [10.1016/j.softx.2021.100741](https://doi.org/10.1016/j.softx.2021.100741).\n\nThe presented software has been extensively used in our research work,\nincluding the study of resonant emission of multi-frequency radiation by\noscillating dissipative solitons in the LLE including third order dispersion\n\n\u003e O. Melchert, A. Demircan, A. Yulin, \"Multi-frequency radiation of dissipative solitons in optical fiber cavities,\" Scientific Reports 10 (2020) 8849, DOI: [10.1038/s41598-020-65426-x](https://doi.org/10.1038/s41598-020-65426-x).\n\nand the dynamics of localized dissipative structures in the generalized LLE with negative quartic group-velocity dispersion \n\n\u003e O. Melchert, A. Yulin, A. Demircan, \"Dynamics of localized dissipative structures in a generalized Lugiato-Lefever model with negative quartic group-velocity dispersion,\" Optics Letters 45 (2020) 2764, DOI: [10.1364/OL.392180](https://www.doi.org/10.1364/OL.392180).\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.\n\n## Acknowledgments\n\nThis work received funding from the Deutsche Forschungsgemeinschaft  (DFG) under\nGermany’s Excellence Strategy within the Cluster of Excellence PhoenixD\n(Photonics, Optics, and Engineering – Innovation Across Disciplines) (EXC 2122,\nprojectID 390833453).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fomelchert%2FpyGLLE","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fomelchert%2FpyGLLE","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fomelchert%2FpyGLLE/lists"}