Metadata-Version: 2.3
Name: janssen
Version: 2025.9.15
Summary: Modular Optical Microscopy with JAX
Keywords: optical microscopy,JAX,ptychography,differentiable programming
Author: Debangshu Mukherjee
Author-email: Debangshu Mukherjee <mukherjeed@ornl.gov>
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.
         
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Typing :: Typed
Classifier: Topic :: Scientific/Engineering :: Image Processing
Requires-Dist: numpy>=1.13.0
Requires-Dist: scipy>=1.0.0
Requires-Dist: matplotlib>=2.2.0
Requires-Dist: matplotlib-scalebar>=0.5.0
Requires-Dist: tqdm>=4.66.0
Requires-Dist: jaxtyping>=0.2.21
Requires-Dist: chex>=0.1.85
Requires-Dist: optax>=0.1.8
Requires-Dist: pytest>=8.0.0
Requires-Dist: beartype>=0.19.0
Requires-Dist: jax[cuda12]>=0.4.30 ; sys_platform == 'linux'
Requires-Dist: jax>=0.4.30 ; sys_platform == 'win64'
Requires-Dist: jax>=0.4.30 ; sys_platform == 'darwin'
Requires-Dist: pytest-cov>=6.2.1
Requires-Dist: jupyterlab>=4.4.5
Requires-Dist: jupyter>=1.1.1
Requires-Dist: ipykernel>=6.29.5
Requires-Dist: black[jupyter]>=25.1.0
Requires-Dist: janssen[docs,test,notebooks] ; extra == 'dev'
Requires-Dist: black>=25.1.0 ; extra == 'dev'
Requires-Dist: ipykernel>=6.29.5 ; extra == 'dev'
Requires-Dist: isort>=6.0.1 ; extra == 'dev'
Requires-Dist: myst-parser>=4.0.1 ; extra == 'dev'
Requires-Dist: nbsphinx>=0.9.6 ; extra == 'dev'
Requires-Dist: pydata-sphinx-theme>=0.16.1 ; extra == 'dev'
Requires-Dist: ruff>=0.12.9 ; extra == 'dev'
Requires-Dist: sphinx>=8.1.3 ; extra == 'dev'
Requires-Dist: sphinx-rtd-theme>=3.0.2 ; extra == 'dev'
Requires-Dist: sphinxcontrib-napoleon>=0.7 ; extra == 'dev'
Requires-Dist: twine>=6.1.0 ; extra == 'dev'
Requires-Dist: furo>=2025.7.19 ; extra == 'docs'
Requires-Dist: ipykernel>=6.29.5 ; extra == 'docs'
Requires-Dist: myst-parser>=4.0.1 ; extra == 'docs'
Requires-Dist: nbsphinx>=0.9.6 ; extra == 'docs'
Requires-Dist: pydata-sphinx-theme>=0.16.1 ; extra == 'docs'
Requires-Dist: sphinx>=8.1.3 ; extra == 'docs'
Requires-Dist: sphinx-autodoc-typehints>=3.0.1 ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme>=3.0.2 ; extra == 'docs'
Requires-Dist: sphinxcontrib-napoleon>=0.7 ; extra == 'docs'
Requires-Dist: pydoclint>=0.7.3 ; extra == 'docs'
Requires-Dist: interrogate>=1.7.0 ; extra == 'docs'
Requires-Dist: pandoc>=2.4 ; extra == 'docs'
Requires-Dist: ipywidgets>=8.1.0 ; extra == 'notebooks'
Requires-Dist: ipykernel>=6.29.5 ; extra == 'notebooks'
Requires-Dist: nbconvert>=7.16.6 ; extra == 'notebooks'
Requires-Dist: pytest>=8.3.5 ; extra == 'test'
Requires-Dist: pytest-cov>=4.0.0 ; extra == 'test'
Requires-Dist: pytest-xdist>=3.0.0 ; extra == 'test'
Requires-Dist: chex>=0.1.89 ; extra == 'test'
Maintainer: Debangshu Mukherjee
Maintainer-email: Debangshu Mukherjee <mukherjeed@ornl.gov>
Requires-Python: >=3.11, <3.14
Project-URL: Homepage, https://github.com/debangshu-mukherjee/janssen
Provides-Extra: dev
Provides-Extra: docs
Provides-Extra: notebooks
Provides-Extra: test
Description-Content-Type: text/markdown

[![PyPI Downloads](https://static.pepy.tech/badge/janssen)](https://pepy.tech/projects/janssen)
[![License](https://img.shields.io/pypi/l/janssen.svg)](https://github.com/debangshu-mukherjee/janssen/blob/main/LICENSE.md)
[![PyPI version](https://img.shields.io/pypi/v/janssen.svg)](https://pypi.python.org/pypi/janssen)
[![Python Versions](https://img.shields.io/pypi/pyversions/janssen.svg)](https://pypi.python.org/pypi/janssen)
[![Documentation Status](https://readthedocs.org/projects/janssen/badge/?version=latest)](https://janssen.readthedocs.io/en/latest/?badge=latest)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.17041632.svg)](https://doi.org/10.5281/zenodo.17041632)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
[![codecov](https://codecov.io/gh/debangshu-mukherjee/janssen/branch/main/graph/badge.svg)](https://codecov.io/gh/debangshu-mukherjee/janssen)
[![jax_badge](https://tinyurl.com/mucknrvu)](https://docs.jax.dev/)

# Janssen: Optical Microscopy with JAX

Janssen is a JAX-based library for optical microscopy simulations and ptychographic reconstructions. It provides differentiable implementations of optical propagation, lens simulations, and phase retrieval algorithms, all optimized for GPU acceleration through JAX.
