| Name | ptyrodactyl JSON |
| Version |
2025.7.15
JSON |
| download |
| home_page | None |
| Summary | Ptychography through differentiable programming in JAX |
| upload_time | 2025-07-26 21:44:06 |
| maintainer | Debangshu Mukherjee |
| docs_url | None |
| author | Debangshu Mukherjee |
| requires_python | <3.13,>=3.11 |
| license | MIT License Copyright (c) 2021 Oak Ridge National Laboratory Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
electron microscopy
optical microscopy
4d-stem
jax
ptychography
differentiable programming
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
|
[](https://pepy.tech/projects/ptyrodactyl)
[](https://opensource.org/licenses/MIT)
[](https://badge.fury.io/py/ptyrodactyl)
[](https://ptyrodactyl.readthedocs.io/en/latest/?badge=latest)
[](https://doi.org/10.5281/zenodo.14861992)
[](https://github.com/psf/black)
[](https://codecov.io/gh/debangshu-mukherjee/ptyrodactyl)
[](https://github.com/debangshu-mukherjee/ptyrodactyl/actions)
# Ptychography through Differentiable Programming
The aim of this project is to write the _forward_ problem: aka writing the microscope data generation, both for electron and optical microscopes in [JAX](https://github.com/google/jax) so that it's end to end differentiable and using this differentiability to run modern optimizers such as [Adam](
https://doi.org/10.48550/arXiv.1412.6980
) and [Adagrad](https://arxiv.org/abs/2003.02395) to solve for the inverse problem - which is ptychography in our case.
All the work here is in Python, performed on a x64 based processor workstation, running Ubuntu Linux 22.04. However, none of the packages here have Linux as a dependency, so this should run in Windows/Mac environments too -- just the path commands may be a bit different.
This will install the package as `ptyrodactyl`, which is the package that all the codes are.
The codes themselves are in the _src_ directory, following the modern toml convention as the _ptyrodactyl_ folder.
Raw data
{
"_id": null,
"home_page": null,
"name": "ptyrodactyl",
"maintainer": "Debangshu Mukherjee",
"docs_url": null,
"requires_python": "<3.13,>=3.11",
"maintainer_email": "Debangshu Mukherjee <mukherjeed@ornl.gov>",
"keywords": "electron microscopy, optical microscopy, 4D-STEM, JAX, ptychography, differentiable programming",
"author": "Debangshu Mukherjee",
"author_email": "Debangshu Mukherjee <mukherjeed@ornl.gov>",
"download_url": "https://files.pythonhosted.org/packages/fc/91/4cec75f99a8255fdfd2c8c3869312c9fd686d8d1285d4d713eda51bb02e8/ptyrodactyl-2025.7.15.tar.gz",
"platform": null,
"description": "[](https://pepy.tech/projects/ptyrodactyl)\n[](https://opensource.org/licenses/MIT)\n[](https://badge.fury.io/py/ptyrodactyl)\n[](https://ptyrodactyl.readthedocs.io/en/latest/?badge=latest)\n[](https://doi.org/10.5281/zenodo.14861992)\n[](https://github.com/psf/black)\n[](https://codecov.io/gh/debangshu-mukherjee/ptyrodactyl)\n[](https://github.com/debangshu-mukherjee/ptyrodactyl/actions)\n\n# Ptychography through Differentiable Programming\n\nThe aim of this project is to write the _forward_ problem: aka writing the microscope data generation, both for electron and optical microscopes in [JAX](https://github.com/google/jax) so that it's end to end differentiable and using this differentiability to run modern optimizers such as [Adam](\nhttps://doi.org/10.48550/arXiv.1412.6980\n) and [Adagrad](https://arxiv.org/abs/2003.02395) to solve for the inverse problem - which is ptychography in our case.\n\nAll the work here is in Python, performed on a x64 based processor workstation, running Ubuntu Linux 22.04. However, none of the packages here have Linux as a dependency, so this should run in Windows/Mac environments too -- just the path commands may be a bit different.\n\nThis will install the package as `ptyrodactyl`, which is the package that all the codes are.\n\n\nThe codes themselves are in the _src_ directory, following the modern toml convention as the _ptyrodactyl_ folder.",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2021 Oak Ridge National Laboratory Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Ptychography through differentiable programming in JAX",
"version": "2025.7.15",
"project_urls": {
"Homepage": "https://github.com/debangshu-mukherjee/ptyrodactyl"
},
"split_keywords": [
"electron microscopy",
" optical microscopy",
" 4d-stem",
" jax",
" ptychography",
" differentiable programming"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "4fce14f75e9aa655b6f20f6c7ab58bdc76d136d1c16cb68dcff9f570c981b9d4",
"md5": "67e3e81961c48d261e148037ad8835f9",
"sha256": "8047afa4b77c01db767bda8c9b7041af0103fba672ac997ad51327adb2691a56"
},
"downloads": -1,
"filename": "ptyrodactyl-2025.7.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "67e3e81961c48d261e148037ad8835f9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.11",
"size": 85380,
"upload_time": "2025-07-26T21:44:05",
"upload_time_iso_8601": "2025-07-26T21:44:05.393762Z",
"url": "https://files.pythonhosted.org/packages/4f/ce/14f75e9aa655b6f20f6c7ab58bdc76d136d1c16cb68dcff9f570c981b9d4/ptyrodactyl-2025.7.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "fc914cec75f99a8255fdfd2c8c3869312c9fd686d8d1285d4d713eda51bb02e8",
"md5": "ba0393219b0cf54003cffcbe1d232bb3",
"sha256": "af018df41914dada9037a3dff3c2adf8ac683111dbd3d98e4495174f0eb1a3a8"
},
"downloads": -1,
"filename": "ptyrodactyl-2025.7.15.tar.gz",
"has_sig": false,
"md5_digest": "ba0393219b0cf54003cffcbe1d232bb3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.11",
"size": 74640,
"upload_time": "2025-07-26T21:44:06",
"upload_time_iso_8601": "2025-07-26T21:44:06.598174Z",
"url": "https://files.pythonhosted.org/packages/fc/91/4cec75f99a8255fdfd2c8c3869312c9fd686d8d1285d4d713eda51bb02e8/ptyrodactyl-2025.7.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-26 21:44:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "debangshu-mukherjee",
"github_project": "ptyrodactyl",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "ptyrodactyl"
}
