Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/source/user-guide/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ User Guide
===========

.. important::
**The User Guide is under development.** For detailed information about the library and the
For detailed information about the library and the
underlying physics, please refer to the `original paper <https://doi.org/10.1016/j.cpc.2022.108291>`_
(`arxiv link <https://arxiv.org/abs/2107.12437>`_).

Expand Down
63 changes: 37 additions & 26 deletions pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,34 +1,48 @@
[build-system]
requires = ["setuptools>=77.0.3", "wheel"]
build-backend = "setuptools.build_meta"
requires = ["hatchling>=1.26", "hatch-vcs"]
build-backend = "hatchling.build"

[project]
name = "pycharge"
version = "2.0.0"
dynamic = ["version"]
authors = [{name = "Matthew Filipovich", email = "matthew.filipovich@physics.ox.ac.uk"}]
description = "Python library for differentiable electrodynamics simulations with jax."
readme = "README.md"
requires-python = ">=3.10"
classifiers = [
"Intended Audience :: Education",
"Intended Audience :: Science/Research",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
"Programming Language :: Python",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3 :: Only",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.13",
"Programming Language :: Python :: 3.14",
"Topic :: Scientific/Engineering :: Physics",
]
license = "MIT"
license-files = ["LICENSE"]
dependencies = [
"jax",
"optimistix"
]
requires-python = ">=3.10"
authors = [{name = "Matthew Filipovich", email = "matthew.filipovich@physics.ox.ac.uk"}]
description = "Python library for differentiable electrodynamics simulations with jax."
readme = "README.md"
license = {file = "LICENSE"}
keywords = [
"electrodynamics",
"jax",
"physics",
"inverse design",
"differentiable optics"
]
classifiers = [
"Programming Language :: Python :: 3",
"Operating System :: OS Independent",
"Intended Audience :: Science/Research",
"Intended Audience :: Education",
"Topic :: Scientific/Engineering :: Physics",
"License :: OSI Approved :: MIT License"
]

[project.urls]
Homepage = "https://github.com/MatthewFilipovich/pycharge"
Documentation = "https://pycharge.readthedocs.io/"
Tracker = "https://github.com/MatthewFilipovich/pycharge/issues"
Changelog = "https://github.com/MatthewFilipovich/pycharge/releases"

[project.optional-dependencies]
dev = [
Expand All @@ -39,26 +53,23 @@ dev = [
"ruff",
"scipy"
]

docs = [
"sphinx-autoapi",
"pydata-sphinx-theme",
"sphinx-copybutton",
"sphinx-gallery",
"sphinx-design",
"matplotlib"
]
]

[project.urls]
Homepage = "https://github.com/MatthewFilipovich/pycharge"
Documentation = "https://pycharge.readthedocs.io/"
Tracker = "https://github.com/MatthewFilipovich/pycharge/issues"
[tool.hatch.build.targets.wheel]
packages = ["src/pycharge"]

[tool.setuptools.packages.find]
where = ["src"]
[tool.hatch.build]
include = ["src/pycharge/py.typed"]

[tool.setuptools.package-data]
"pycharge" = ["py.typed"]
[tool.hatch.version]
source = "vcs"

[tool.ruff]
line-length = 110
Expand Down
1 change: 0 additions & 1 deletion uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.