{"id":46087765,"url":"https://github.com/arielmission-space/paos","last_synced_at":"2026-03-01T17:02:27.730Z","repository":{"id":215181301,"uuid":"406776052","full_name":"arielmission-space/PAOS","owner":"arielmission-space","description":"PAOS is a fast, modern, and reliable Python package for Physical Optics studies.","archived":false,"fork":false,"pushed_at":"2025-11-11T21:27:38.000Z","size":142403,"stargazers_count":10,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2026-01-21T21:06:59.172Z","etag":null,"topics":["fresnel","gui","open-source","optics","optics-simulation","paos","psf","python","ray-tracing","wavefront"],"latest_commit_sha":null,"homepage":"https://paos.readthedocs.io/en/latest/","language":"Jupyter Notebook","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/arielmission-space.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.rst","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"code_of_conduct.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2021-09-15T13:28:01.000Z","updated_at":"2025-11-13T11:00:45.000Z","dependencies_parsed_at":"2024-08-23T12:26:52.402Z","dependency_job_id":"bc2c8a96-94a1-485c-84dc-4c3fb4a96721","html_url":"https://github.com/arielmission-space/PAOS","commit_stats":null,"previous_names":["arielmission-space/paos"],"tags_count":129,"template":false,"template_full_name":null,"purl":"pkg:github/arielmission-space/PAOS","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arielmission-space%2FPAOS","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arielmission-space%2FPAOS/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arielmission-space%2FPAOS/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arielmission-space%2FPAOS/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/arielmission-space","download_url":"https://codeload.github.com/arielmission-space/PAOS/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/arielmission-space%2FPAOS/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29976272,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-01T16:35:47.903Z","status":"ssl_error","status_checked_at":"2026-03-01T16:35:44.899Z","response_time":124,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["fresnel","gui","open-source","optics","optics-simulation","paos","psf","python","ray-tracing","wavefront"],"created_at":"2026-03-01T17:02:25.101Z","updated_at":"2026-03-01T17:02:27.704Z","avatar_url":"https://github.com/arielmission-space.png","language":"Jupyter Notebook","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ``PAOS``\n\n[![PyPI version](https://badge.fury.io/py/paos.svg?icon=si%3Apython)](https://badge.fury.io/py/paos)\n[![GitHub version](https://badge.fury.io/gh/arielmission-space%2FPAOS.svg?icon=si%3Agithub)](https://badge.fury.io/gh/arielmission-space%2FPAOS)\n[![Downloads](https://static.pepy.tech/badge/paos)](https://pepy.tech/project/paos)\n[![License](https://img.shields.io/badge/License-BSD%203--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)\n[![Documentation Status](https://readthedocs.org/projects/paos/badge/?version=latest)](https://paos.readthedocs.io/en/latest/?badge=latest)\n[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](code_of_conduct.md)\n[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/arielmission-space/PAOS)\n\n## Introduction\n\n``PAOS``, the Physical Optics Simulator, is a fast, modern, and reliable Python package for Physical Optics studies.\n\nIt implements Physical Optics Propagation in Fresnel approximation and paraxial ray tracing to analyze complex waveform propagation through both generic and off-axes optical systems.\n\nIt handles diffractive materials and can implement wavefront aberrations as Zernike polynomials, orthonormal polynomials, or grid sags.\n\n## Table of contents\n\n- [``PAOS``](#paos)\n  - [Introduction](#introduction)\n  - [Table of contents](#table-of-contents)\n  - [How to install](#how-to-install)\n    - [Install from PyPI](#install-from-pypi)\n    - [Install from source code](#install-from-source-code)\n      - [Test your installation](#test-your-installation)\n    - [Interactive Marimo Notebooks](#interactive-marimo-notebooks)\n  - [Documentation](#documentation)\n    - [Build the html documentation](#build-the-html-documentation)\n    - [Build the pdf documentation](#build-the-pdf-documentation)\n  - [How to contribute](#how-to-contribute)\n  - [How to cite](#how-to-cite)\n\n## How to install\n\nInstructions on how to install ``PAOS``.\n\n### Install from PyPI\n\n``PAOS`` is available on PyPI and can be installed via pip as\n\n    pip install paos\n\n### Install from source code\n\n``PAOS`` is compatible (tested) with Python 3.9+\n\nTo install from source, clone the [repository](https://github.com/arielmission-space/PAOS/) and move inside the directory.\n\nThen use `pip` as\n\n    pip install .\n\n#### Test your installation\n\nTry importing ``PAOS`` as\n\n    python -c \"import paos; print(paos.__version__)\"\n\nOr running ``PAOS`` itself with the `help` flag as\n\n    paos -h\n\nOr the Graphical User Interface with the `help` flag as\n\n    paos_gui -h\n\nIf there are no errors then the installation was successful!\n\n### Interactive Marimo Notebooks\n\nPAOS provides interactive [marimo](https://github.com/marimo-team/marimo) notebooks to showcase (some of) its capabilities. These notebooks allow you to explore PAOS features in a live, browser-based environment.\n\n**Available marimo notebooks:**\n\n- `notebook/paos_demo.py`\n- `notebook/material.py`\n- `notebook/psd.py`\n\n*Note: These notebooks are available only in PAOS version 1.2.6 and later.*\n\n**How to run a marimo notebook:**\n\nAfter installing PAOS, marimo is already available.\n\nTo launch a notebook (for example):\n\n    marimo run notebook/paos_demo.py\n\nThis will open the interactive notebook in your browser.\n\n## Documentation\n\n``PAOS`` comes with an extensive documentation, which can be built using Sphinx.\nThe documentation includes a tutorial, a user guide and a reference guide.\n\nTo build the documentation, install the needed packages first via `poetry`:\n\n    pip install poetry\n    poetry install --with docs\n\n### Build the html documentation\n\nTo build the html documentation, move into the `docs` directory and run\n\n    make html\n\nThe documentation will be produced into the `build/html` directory inside `docs`.\nOpen `index.html` to read the documentation.\n\n### Build the pdf documentation\n\nTo build the pdf, move into the `docs` directory and run\n\n    make latexpdf\n\nThe documentation will be produced into the `build/latex` directory inside `docs`.\nOpen `paos.pdf` to read the documentation.\n\nThe developers use `pdflatex`; if you have another compiler for LaTex, please refer to [sphinx documentation](https://www.sphinx-doc.org/en/master/usage/configuration.html#latex-options).\n\n## How to contribute\n\nYou can contribute to ``PAOS`` by reporting bugs, suggesting new features, or contributing to the code itself.\nIf you wish to contribute to the code, please follow the steps described in the documentation under `Developer Guide`.\n\n## How to cite\n\n```bibtex\n@INPROCEEDINGS{2024SPIE13092E..4KB,\n       author = {{Bocchieri}, Andrea and {Mugnai}, Lorenzo V. and {Pascale}, Enzo},\n        title = \"{PAOS: a fast, modern, and reliable Python package for physical optics studies}\",\n    booktitle = {Space Telescopes and Instrumentation 2024: Optical, Infrared, and Millimeter Wave},\n         year = 2024,\n       editor = {{Coyle}, Laura E. and {Matsuura}, Shuji and {Perrin}, Marshall D.},\n       series = {Society of Photo-Optical Instrumentation Engineers (SPIE) Conference Series},\n       volume = {13092},\n        month = aug,\n          eid = {130924K},\n        pages = {130924K},\n          doi = {10.1117/12.3018333},\n       adsurl = {https://ui.adsabs.harvard.edu/abs/2024SPIE13092E..4KB},\n      adsnote = {Provided by the SAO/NASA Astrophysics Data System}\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farielmission-space%2Fpaos","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farielmission-space%2Fpaos","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farielmission-space%2Fpaos/lists"}