{"id":13736458,"url":"https://github.com/philmain28/philsol","last_synced_at":"2025-05-08T12:32:55.485Z","repository":{"id":55039769,"uuid":"106692025","full_name":"philmain28/philsol","owner":"philmain28","description":"Simple python library for calculating the modes of electromagnetic waveguides using finite difference frequency domain method. ","archived":false,"fork":false,"pushed_at":"2021-09-21T10:22:54.000Z","size":2956,"stargazers_count":33,"open_issues_count":1,"forks_count":8,"subscribers_count":5,"default_branch":"master","last_synced_at":"2024-10-03T06:52:04.261Z","etag":null,"topics":["eigensolver","electromagnetism","fdfd","mode","solver","waveguide"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/philmain28.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-10-12T12:48:59.000Z","updated_at":"2024-08-11T13:34:16.000Z","dependencies_parsed_at":"2022-08-14T09:50:39.170Z","dependency_job_id":null,"html_url":"https://github.com/philmain28/philsol","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/philmain28%2Fphilsol","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/philmain28%2Fphilsol/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/philmain28%2Fphilsol/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/philmain28%2Fphilsol/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/philmain28","download_url":"https://codeload.github.com/philmain28/philsol/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224732129,"owners_count":17360416,"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":["eigensolver","electromagnetism","fdfd","mode","solver","waveguide"],"created_at":"2024-08-03T03:01:22.137Z","updated_at":"2024-11-15T04:31:52.004Z","avatar_url":"https://github.com/philmain28.png","language":"Python","readme":"# philsol\n## Modes for the Masses (Massless?)\nFed up with relying on expensive proprietary software for your electromagnetic waveguide research?  philsol might just be the package for you. In a world where high performance hardware is cheaper than specialist software, philsol throws elegence and sophistication out of the window and replaces it with brute force. \n\nThis is a fully vectorial finite difference waveguide mode solver and a direct Python implimentation of the algorithm found in the paper: \n['Full-vectorial finite-difference analysis of microstructured optical fibres', by Zhu and Brown.](https://doi.org/10.1364/OE.10.000853)\n\nWarning: I haven't thoroughly tested so be wary and check the results are sensible...\n\nNew Warning: Original paper by Zhu and Brown is in gaussian not S. I. units. \nTo correct use conversion table [here](https://en.wikipedia.org/wiki/Gaussian_units).\n\n## Installation\n- Install using pip with command 'pip install philsol'\n- If you can't be bothered, the important part is the function eigenbuild in core.py. \n\n## Examples\n- Commented example projects can be found in the *examples* directory.\n- To run the examples, first install philsol to your Python environment (see above)\n\n## Features\n### Solver\n- Solves vector Maxwell(Helmholtz) equations in 2D for arbitary refractive index profile.\n- Return x and y componants of electric field.\n- philsol can handle anisotropic refractive indices with diagonal tensor.\n- Choice of solving routines: the default scipy.sparse solver or Slepc (slepc4py and petsc4py) this libraries can be fiddly to set up but are very heavily featured including some limited GPU support.  \n- Extra field componants Ez, Hx, Hy, Hz can be calculated from construct module\n- Perfect electric conductor, periodic and absorbing boundary conditions. \n\n### Geometry building\n- The quickest way of importing geometry is with a bitmap image \n- See *examples/example_image.py* and *examples/Hollow_Core_Fibre.ipynb* for examples loading .bpm images\n- See *examples/example_build.py* for an example in building geometry using PIL/Pillow\n- See *examples/Boundary Interpolation Example.ipynb* for an attempt to handle curved boundaries with pillows anti-aliasing capabilities \n\n## Final Note \nI wrote this code a while ago for my [PhD](https://purehost.bath.ac.uk/ws/portalfiles/portal/200802035/philip_main_thesis.pdf) but sometimes I get nostalgic about photonics so if you are doing anything cool with philsol I would love to know about it. \n\n\n","funding_links":[],"categories":["simulation"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphilmain28%2Fphilsol","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fphilmain28%2Fphilsol","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fphilmain28%2Fphilsol/lists"}