pyproject.toml

[tool.poetry]
name = "tidy3d"
version = "2.8.3"
description = "A fast FDTD solver"
authors = ["Tyler Hughes <tyler@flexcompute.com>"]
license = "LGPLv2+"
readme = "README.md"
homepage = "https://github.com/flexcompute/tidy3d"
repository = "https://github.com/flexcompute/tidy3d"
classifiers = [
  "License :: OSI Approved :: GNU Lesser General Public License v2 or later (LGPLv2+)",
  "Programming Language :: Python :: 3.9",
  "Programming Language :: Python :: 3.10",
  "Programming Language :: Python :: 3.11",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: 3.13",
  "Operating System :: OS Independent",
]
documentation = "https://docs.flexcompute.com/projects/tidy3d/en/latest/"

[tool.poetry.urls]
"Bug Tracker" = "https://github.com/flexcompute/tidy3d/issues"

[tool.poetry.dependencies]
python = ">=3.9,<3.14"
pyroots = ">=0.5.0"
xarray = ">=2023.08"
importlib-metadata = ">=6.0.0"
h5netcdf = "1.0.2"
h5py = "^3.0.0"
rich = "^13.0"
numpy = "*"
matplotlib = "*"
shapely = "^2.0"
pandas = "*"
pydantic = "^2.0"
PyYAML = "*"
dask = "*"
toml = "*"
autograd = ">=1.7.0"
scipy = "*"
### NOT CORE
boto3 = "^1.28.0"
requests = "^2.31.0"
pyjwt = "*"
click = "^8.1.0"
responses = "*"
joblib = "*"
### END NOT CORE

### Optional dependencies ###
# development core
bump-my-version = { version = "*", optional = true }
ruff = { version = "0.5.5", optional = true }
coverage = { version = "*", optional = true }
dill = { version = "*", optional = true }
ipython = { version = "*", optional = true }
memory_profiler = { version = "*", optional = true }
psutil = { version = "*", optional = true }
pre-commit = { version = "*", optional = true }
pylint = { version = "*", optional = true }
pytest = { version = ">=8.1", optional = true }
pytest-timeout = { version = "*", optional = true }
pytest-xdist = "^3.6.1"
pytest-cov = "^6.0.0"
pytest-env = "^1.1.5"
tox = { version = "*", optional = true }

# gdspy
gdspy = { version = "*", optional = true }

# gdstk
gdstk = { version = ">=0.9.49", optional = true }

# jax
jaxlib = { version = ">=0.4.26", source = "jaxsource", optional = true }
jax = { version = ">=0.4.26", extras = [
  "cpu",
], source = "jaxsource", optional = true }

# design
bayesian-optimization = { version = "<2", optional = true }
pygad = { version = "3.3.1", optional = true }
pyswarms = { version = "*", optional = true }

# pytorch
torch = [
    { version = "^2.2.0", source = "PyPI", platform = "darwin", optional = true },
    { version = "^2.2.0", source = "torch-cpu", platform = "!=darwin", optional = true },
]

# scikit-rf
scikit-rf = { version = "*", optional = true }

# trimesh
networkx = { version = "^2.6.3", optional = true }
rtree = { version = "1.2.0", optional = true }
trimesh = { version = "^4", optional = true }

# docs
jupyter = { version = "*", optional = true }
jinja2 = { version = ">=3.1.2", optional = true }
nbconvert = { version = ">=7.11.0", optional = true }
sphinx = { version = ">=6", optional = true }
nbsphinx = { version = ">=0.8.7", optional = true }
sphinx-copybutton = { version = ">=0.5.2", optional = true }
sphinx-book-theme = { version = ">=1.0.1", optional = true }
pydata-sphinx-theme = { version = ">=0.13.3", optional = true }
# divparams = {optional = true, git = "https://github.com/daquinteroflex/sphinxcontrib-divparams.git"} # TODO FIX
tmm = { version = "*", optional = true }
grcwa = { version = "*", optional = true }
sphinx-design = { version = "*", optional = true }
sphinx-favicon = { version = "*", optional = true }
sphinx-sitemap = { version = ">=2.5.1", optional = true }
sphinx-notfound-page = { version = "*", optional = true }
sphinx-tabs = { version = "*", optional = true }
nbdime = { version = "*", optional = true }
myst-parser = { version = "*", optional = true }
optax = { version = ">=0.2.2", optional = true }
signac = { version = "*", optional = true }
flax = { version = ">=0.8.2", optional = true }
sax = { version = "^0.11", optional = true }
vtk = { version = ">=9.2.6", optional = true }
sphinxemoji = { version = "*", optional = true }
devsim = { version = "*", optional = true }
cma = { version = "*", optional = true }

[tool.poetry.extras]
dev = [
  'bayesian-optimization',
  'bump-my-version',
  "coverage",
  'dill',
  'divparams',
  'gdspy',
  'gdstk',
  'grcwa',
  'ipython',
  'ipython',
  'jax',
  'jaxlib',
  'torch',
  'jinja2',
  'jupyter',
  'myst-parser',
  'memory_profiler',
  'psutil',
  'nbconvert',
  'nbdime',
  'nbsphinx',
  'networkx',
  'optax',
  'pre-commit',
  'pydata-sphinx-theme',
  'pygad',
  'pylint',
  'pyswarms',
  'pytest',
  'pytest-timeout',
  'pytest-xdist',
  'pytest-env',
  'pytest-cov',
  'rtree',
  'ruff',
  'sax',
  'signac',
  'sphinx',
  'sphinx-book-theme',
  'sphinx-design',
  'sphinx-copybutton',
  'sphinx-favicon',
  'sphinx-notfound-page',
  'sphinx-sitemap',
  'sphinx-tabs',
  'sphinxemoji',
  'tmm',
  'tox',
  'trimesh',
  'scikit-rf',
  'vtk',
  'devsim',
  'cma',
]
docs = [
  "jupyter",
  "jinja2",
  "nbconvert",
  "sphinx",
  "nbsphinx",
  "ipython",
  "divparams",
  'sphinx-design',
  "sphinx-copybutton",
  'sphinx-favicon',
  "sphinx-book-theme",
  "pydata-sphinx-theme",
  "tmm",
  "gdstk",
  "grcwa",
  "sphinx-sitemap",
  'sphinx-notfound-page',
  "nbdime",
  "optax",
  "signac",
  "sax",
  "pylint",
  "sphinx-tabs",
  "sphinxemoji",
  "myst-parser",
  "devsim",
  "cma",
]
gdspy = ["gdspy"]
gdstk = ["gdstk"]
scikit-rf = ["scikit-rf"]
trimesh = ["trimesh", "networkx", "rtree"]
vtk = ["vtk"]
ruff = ["ruff"]
heatcharge = ["trimesh", "vtk", "devsim"]
# plugins with extra deps
adjoint = ["jaxlib", "jax"]
pytorch = ["torch"]
design = ["bayesian-optimization", "pygad", "pyswarms"]

[tool.poetry.scripts]
tidy3d = "tidy3d.web.cli:tidy3d_cli"

[[tool.poetry.source]]
name = "pypi"
priority = "primary"

[[tool.poetry.source]]
name = "jaxsource"
url = "https://storage.googleapis.com/jax-releases/jax_releases.html"
priority = "supplemental"

[[tool.poetry.source]]
name = "torch-cpu"
url = "https://download.pytorch.org/whl/cpu"
priority = "explicit"

[build-system]
requires = ["poetry-core>=1.0.0"]
build-backend = "poetry.core.masonry.api"

[tool.ruff]
target-version = "py39"
line-length = 100
extend-exclude = ["docs/faq/", "docs/notebooks/"]

[tool.ruff.lint]
typing-modules = [
  "tidy3d.components.types",
] # without this Literal["something fails"]
select = [
  "I",      # isort
  "E",      # pycodestyle errors
  "W",      # pycodestyle warnings
  "F",      # pyflakes
  "C",      # flake8-comprehensions
  "B",      # flake8-bugbear
  "UP",
  "NPY201", # numpy 2.* compatibility check
]
ignore = [
  "E501",
  "B008",  # do not perform function calls in argument defaults
  "C901",  # too complex
  "UP007", # use x | y instead of union[x,y] (does not work)
  "B905",  # `zip()` without an explicit `strict=` parameter
  "C408",  # C408 Unnecessary `dict` call (rewrite as a literal)
  "B904",
  "B028",  # stacklevel
  "UP006", # typy annotation with Tuple[float] messes up pydantic
  "UP038", # TODO decide what to do here
  "UP035", # TODO decide what to do here
]

[tool.pytest.ini_options]
# TODO: remove --assert=plain when https://github.com/scipy/scipy/issues/22236 is resolved
addopts = "--cov=tidy3d --doctest-modules -n auto --dist worksteal --assert=plain -m 'not numerical' "
markers = [
    "numerical: marks numerical tests for adjoint gradients that require running simulations (deselect with '-m \"not numerical\"')",
]
env = ["MPLBACKEND=Agg", "OMP_NUM_THREADS=1"]
doctest_optionflags = "NORMALIZE_WHITESPACE ELLIPSIS"
norecursedirs = [
  "tests/_test_local",
  "tests/test_cli",
  "tests/_test_data",
  "tests/_test_notebooks",
  "tidy3d/web",
  "docs/notebooks",
  "docs/faq",
]
filterwarnings = "ignore::DeprecationWarning"
testpaths = ["tidy3d", "tests", "docs"]
python_files = "*.py"

[tool.bumpversion]
current_version = "2.8.3"
parse = """(?x)
    (?P<major>0|[1-9]\\d*)\\.
    (?P<minor>0|[1-9]\\d*)\\.
    (?P<patch>0|[1-9]\\d*)
    (?:
        (?P<pre_l>[a-zA-Z-]+)         # pre-release label
        (?P<pre_n>0|[1-9]\\d*)        # pre-release version number
    )?                                # pre-release section is optional
"""
serialize = ["{major}.{minor}.{patch}{pre_l}{pre_n}", "{major}.{minor}.{patch}"]
search = "{current_version}"
replace = "{new_version}"
regex = false
ignore_missing_version = true
ignore_missing_files = false
tag = false
sign_tags = false
tag_name = "v{new_version}"
tag_message = "Bump version: {current_version} → {new_version}"
allow_dirty = false
commit = false
message = "Bump version: {current_version} → {new_version}"
commit_args = ""

[tool.bumpversion.parts.pre_l]
values = ["rc", ""]

[[tool.bumpversion.files]]
filename = "pyproject.toml"
search = "\nversion = \"{current_version}\""
replace = "\nversion = \"{new_version}\""

[[tool.bumpversion.files]]
filename = "tidy3d/version.py"
search = "{current_version}"
replace = "{new_version}"