From 89d9d43badb2eb89cfdf017e7bb429e3f086f8aa Mon Sep 17 00:00:00 2001 From: daquintero Date: Fri, 23 Feb 2024 13:10:47 +0100 Subject: [PATCH] FIX: Post 2.6 release :rotating_light: --- docs/api/charge/index.rst | 10 ++++++ docs/api/charge/mediums.rst | 11 ++++++ docs/api/heat/mediums.rst | 12 +++++++ docs/api/index.rst | 1 + docs/api/mediums.rst | 12 +++++++ docs/api/submit_simulations.rst | 2 +- docs/conf.py | 3 +- docs/faq | 2 +- docs/install.rst | 2 +- docs/notebooks | 2 +- poetry.lock | 60 +++++++++++++++++++++------------ pyproject.toml | 5 +-- 12 files changed, 94 insertions(+), 28 deletions(-) create mode 100644 docs/api/charge/index.rst create mode 100644 docs/api/charge/mediums.rst diff --git a/docs/api/charge/index.rst b/docs/api/charge/index.rst new file mode 100644 index 000000000..f778d419f --- /dev/null +++ b/docs/api/charge/index.rst @@ -0,0 +1,10 @@ +CHARGE |:zap:| +============== + +.. toctree:: + :hidden: + + mediums + + +.. include:: /api/charge/mediums.rst \ No newline at end of file diff --git a/docs/api/charge/mediums.rst b/docs/api/charge/mediums.rst new file mode 100644 index 000000000..266c4e89a --- /dev/null +++ b/docs/api/charge/mediums.rst @@ -0,0 +1,11 @@ +.. currentmodule:: tidy3d + +Charge Perturbation Specification +------------------------------------ + +.. autosummary:: + :toctree: ../_autosummary/ + :template: module.rst + + tidy3d.LinearChargePerturbation + tidy3d.CustomChargePerturbation diff --git a/docs/api/heat/mediums.rst b/docs/api/heat/mediums.rst index 8c76fb996..f304e47bb 100644 --- a/docs/api/heat/mediums.rst +++ b/docs/api/heat/mediums.rst @@ -9,3 +9,15 @@ Material Thermal Specification tidy3d.FluidSpec tidy3d.SolidSpec + + +Thermal Perturbation Specification +------------------------------------ + +.. autosummary:: + :toctree: ../_autosummary/ + :template: module.rst + + tidy3d.LinearHeatPerturbation + tidy3d.CustomHeatPerturbation + diff --git a/docs/api/index.rst b/docs/api/index.rst index b1d9b91d5..ea5cea92c 100644 --- a/docs/api/index.rst +++ b/docs/api/index.rst @@ -20,6 +20,7 @@ API |:computer:| logging submit_simulations heat/index + charge/index plugins/index constants abstract_base diff --git a/docs/api/mediums.rst b/docs/api/mediums.rst index 5d38891b0..adbc2fe75 100644 --- a/docs/api/mediums.rst +++ b/docs/api/mediums.rst @@ -52,6 +52,18 @@ Spatially varying tidy3d.CustomDrude tidy3d.CustomDebye + +Medium Perturbations +-------------------- + +.. autosummary:: + :toctree: _autosummary/ + :template: module.rst + + tidy3d.PerturbationMedium + tidy3d.PerturbationPoleResidue + + General Mediums (can be both dispersive and non-dispersive) ----------------------------------------------------------- diff --git a/docs/api/submit_simulations.rst b/docs/api/submit_simulations.rst index eda4e99a2..d4707003d 100644 --- a/docs/api/submit_simulations.rst +++ b/docs/api/submit_simulations.rst @@ -24,7 +24,7 @@ Through python API tidy3d.web.api.webapi.download_log tidy3d.web.api.webapi.download_json tidy3d.web.api.webapi.load_simulation - tidy3d.web.api.webapi.run_async + tidy3d.web.api.asynchronous.run_async Convenience for Single and Batch -------------------------------- diff --git a/docs/conf.py b/docs/conf.py index fefb7433b..4514bb9bc 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -80,6 +80,7 @@ "IPython.sphinxext.ipython_directive", "IPython.sphinxext.ipython_console_highlighting", "nbsphinx", # Integrate Jupyter Notebooks and Sphinx + "notfound.extension", "myst_parser", # "sphinxcontrib.divparams", # TODO FIX "sphinx.ext.autodoc", # Core Sphinx library for auto html doc generation from docstrings @@ -112,7 +113,7 @@ html_css_files = [ "css/custom.css", ] -html_extra_path = ["./_static/robots.txt"] +html_extra_path = ["./_static/robots.txt", "./_static/"] html_favicon = "_static/logo.ico" html_js_files = ["js/custom-download.js"] htmlhelp_basename = "tidy3ddoc" diff --git a/docs/faq b/docs/faq index c8019bb90..c3ebbbe99 160000 --- a/docs/faq +++ b/docs/faq @@ -1 +1 @@ -Subproject commit c8019bb904ef965c1be24d3c4193bc8149193961 +Subproject commit c3ebbbe99d7d4cc5255d58131927c5cc1c18ff11 diff --git a/docs/install.rst b/docs/install.rst index b54407e4b..44cea860b 100644 --- a/docs/install.rst +++ b/docs/install.rst @@ -177,7 +177,7 @@ Next Steps That should get you started! -To see some other examples of Tidy3D being used in large scale photonics simulations, see `Examples <./examples.html>`_. +To see some other examples of Tidy3D being used in large scale photonics simulations, see `Examples <./notebooks/docs/index.html>`_. To learn more about the many features of Tidy3D, check out our `Feature Walkthrough <./notebooks/Simulation.html>`_. diff --git a/docs/notebooks b/docs/notebooks index 3438c4482..c760c29d9 160000 --- a/docs/notebooks +++ b/docs/notebooks @@ -1 +1 @@ -Subproject commit 3438c4482f6154c4a9aa038542ff34e909c7e374 +Subproject commit c760c29d94fa6f233e93c8e9570e4bfcb8f215ae diff --git a/poetry.lock b/poetry.lock index 60394df08..6767339e5 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1259,12 +1259,13 @@ tqdm = ["tqdm"] [[package]] name = "future" -version = "0.18.3" +version = "1.0.0" description = "Clean single-source support for Python 3 and 2" optional = true python-versions = ">=2.6, !=3.0.*, !=3.1.*, !=3.2.*" files = [ - {file = "future-0.18.3.tar.gz", hash = "sha256:34a17436ed1e96697a86f9de3d15a3b0be01d8bc8de9c1dffd59fb8234ed5307"}, + {file = "future-1.0.0-py3-none-any.whl", hash = "sha256:929292d34f5872e70396626ef385ec22355a1fae8ad29e1a734c3e43f9fbc216"}, + {file = "future-1.0.0.tar.gz", hash = "sha256:bd2968309307861edae1458a4f8a4f3598c03be43b97521076aebf5d94c07b05"}, ] [[package]] @@ -1442,13 +1443,13 @@ numpy = ">=1.17.3" [[package]] name = "httpcore" -version = "1.0.3" +version = "1.0.4" description = "A minimal low-level HTTP client." optional = true python-versions = ">=3.8" files = [ - {file = "httpcore-1.0.3-py3-none-any.whl", hash = "sha256:9a6a501c3099307d9fd76ac244e08503427679b1e81ceb1d922485e2f2462ad2"}, - {file = "httpcore-1.0.3.tar.gz", hash = "sha256:5c0f9546ad17dac4d0772b0808856eb616eb8b48ce94f49ed819fd6982a8a544"}, + {file = "httpcore-1.0.4-py3-none-any.whl", hash = "sha256:ac418c1db41bade2ad53ae2f3834a3a0f5ae76b56cf5aa497d2d033384fc7d73"}, + {file = "httpcore-1.0.4.tar.gz", hash = "sha256:cb2839ccfcba0d2d3c1131d3c3e26dfc327326fbe7a5dc0dbfe9f6c9151bb022"}, ] [package.dependencies] @@ -1459,17 +1460,17 @@ h11 = ">=0.13,<0.15" asyncio = ["anyio (>=4.0,<5.0)"] http2 = ["h2 (>=3,<5)"] socks = ["socksio (==1.*)"] -trio = ["trio (>=0.22.0,<0.24.0)"] +trio = ["trio (>=0.22.0,<0.25.0)"] [[package]] name = "httpx" -version = "0.26.0" +version = "0.27.0" description = "The next generation HTTP client." optional = true python-versions = ">=3.8" files = [ - {file = "httpx-0.26.0-py3-none-any.whl", hash = "sha256:8915f5a3627c4d47b73e8202457cb28f1266982d1159bd5779d86a80c0eab1cd"}, - {file = "httpx-0.26.0.tar.gz", hash = "sha256:451b55c30d5185ea6b23c2c793abf9bb237d2a7dfb901ced6ff69ad37ec1dfaf"}, + {file = "httpx-0.27.0-py3-none-any.whl", hash = "sha256:71d5465162c13681bff01ad59b2cc68dd838ea1f10e51574bac27103f00c91a5"}, + {file = "httpx-0.27.0.tar.gz", hash = "sha256:a0cb88a46f32dc874e04ee956e4c2764aba2aa228f650b06788ba6bda2962ab5"}, ] [package.dependencies] @@ -4019,7 +4020,6 @@ files = [ {file = "PyYAML-6.0.1-cp311-cp311-win_amd64.whl", hash = "sha256:bf07ee2fef7014951eeb99f56f39c9bb4af143d8aa3c21b1677805985307da34"}, {file = "PyYAML-6.0.1-cp312-cp312-macosx_10_9_x86_64.whl", hash = "sha256:855fb52b0dc35af121542a76b9a84f8d1cd886ea97c84703eaa6d88e37a2ad28"}, {file = "PyYAML-6.0.1-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:40df9b996c2b73138957fe23a16a4f0ba614f4c0efce1e9406a184b6d07fa3a9"}, - {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:a08c6f0fe150303c1c6b71ebcd7213c2858041a7e01975da3a99aed1e7a378ef"}, {file = "PyYAML-6.0.1-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6c22bec3fbe2524cde73d7ada88f6566758a8f7227bfbf93a408a9d86bcc12a0"}, {file = "PyYAML-6.0.1-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:8d4e9c88387b0f5c7d5f281e55304de64cf7f9c0021a3525bd3b1c542da3b0e4"}, {file = "PyYAML-6.0.1-cp312-cp312-win32.whl", hash = "sha256:d483d2cdf104e7c9fa60c544d92981f12ad66a457afae824d146093b8c294c54"}, @@ -4595,19 +4595,19 @@ win32 = ["pywin32"] [[package]] name = "setuptools" -version = "69.1.0" +version = "69.1.1" description = "Easily download, build, install, upgrade, and uninstall Python packages" optional = true python-versions = ">=3.8" files = [ - {file = "setuptools-69.1.0-py3-none-any.whl", hash = "sha256:c054629b81b946d63a9c6e732bc8b2513a7c3ea645f11d0139a2191d735c60c6"}, - {file = "setuptools-69.1.0.tar.gz", hash = "sha256:850894c4195f09c4ed30dba56213bf7c3f21d86ed6bdaafb5df5972593bfc401"}, + {file = "setuptools-69.1.1-py3-none-any.whl", hash = "sha256:02fa291a0471b3a18b2b2481ed902af520c69e8ae0919c13da936542754b4c56"}, + {file = "setuptools-69.1.1.tar.gz", hash = "sha256:5c0806c7d9af348e6dd3777b4f4dbb42c7ad85b190104837488eab9a7c945cf8"}, ] [package.extras] docs = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "pygments-github-lexers (==0.0.5)", "rst.linker (>=1.9)", "sphinx (<7.2.5)", "sphinx (>=3.5)", "sphinx-favicon", "sphinx-inline-tabs", "sphinx-lint", "sphinx-notfound-page (>=1,<2)", "sphinx-reredirects", "sphinxcontrib-towncrier"] -testing = ["build[virtualenv]", "filelock (>=3.4.0)", "flake8-2020", "ini2toml[lite] (>=0.9)", "jaraco.develop (>=7.21)", "jaraco.envs (>=2.2)", "jaraco.path (>=3.2.0)", "pip (>=19.1)", "pytest (>=6)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-home (>=0.5)", "pytest-mypy (>=0.9.1)", "pytest-perf", "pytest-ruff (>=0.2.1)", "pytest-timeout", "pytest-xdist", "tomli-w (>=1.0.0)", "virtualenv (>=13.0.0)", "wheel"] -testing-integration = ["build[virtualenv] (>=1.0.3)", "filelock (>=3.4.0)", "jaraco.envs (>=2.2)", "jaraco.path (>=3.2.0)", "packaging (>=23.1)", "pytest", "pytest-enabler", "pytest-xdist", "tomli", "virtualenv (>=13.0.0)", "wheel"] +testing = ["build[virtualenv]", "filelock (>=3.4.0)", "flake8-2020", "ini2toml[lite] (>=0.9)", "jaraco.develop (>=7.21)", "jaraco.envs (>=2.2)", "jaraco.path (>=3.2.0)", "packaging (>=23.2)", "pip (>=19.1)", "pytest (>=6)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-home (>=0.5)", "pytest-mypy (>=0.9.1)", "pytest-perf", "pytest-ruff (>=0.2.1)", "pytest-timeout", "pytest-xdist", "tomli-w (>=1.0.0)", "virtualenv (>=13.0.0)", "wheel"] +testing-integration = ["build[virtualenv] (>=1.0.3)", "filelock (>=3.4.0)", "jaraco.envs (>=2.2)", "jaraco.path (>=3.2.0)", "packaging (>=23.2)", "pytest", "pytest-enabler", "pytest-xdist", "tomli", "virtualenv (>=13.0.0)", "wheel"] [[package]] name = "shapely" @@ -4814,6 +4814,24 @@ sphinx = ">=1.8" code-style = ["pre-commit (==2.12.1)"] rtd = ["ipython", "myst-nb", "sphinx", "sphinx-book-theme", "sphinx-examples"] +[[package]] +name = "sphinx-notfound-page" +version = "1.0.0" +description = "Sphinx extension to build a 404 page with absolute URLs" +optional = true +python-versions = ">=3.8" +files = [ + {file = "sphinx_notfound_page-1.0.0-py3-none-any.whl", hash = "sha256:40a5741a6b07245a08fe55dbbd603ad6719e191b1419ab2e5337c706ebd16554"}, + {file = "sphinx_notfound_page-1.0.0.tar.gz", hash = "sha256:14cd388956de5cdf8710ab4ff31776ef8d85759c4f46014ee30f368e83bd3a3b"}, +] + +[package.dependencies] +sphinx = ">=5" + +[package.extras] +doc = ["sphinx-autoapi", "sphinx-rtd-theme", "sphinx-tabs", "sphinxemoji"] +test = ["tox"] + [[package]] name = "sphinx-sitemap" version = "2.5.1" @@ -5295,13 +5313,13 @@ socks = ["PySocks (>=1.5.6,!=1.5.7,<2.0)"] [[package]] name = "virtualenv" -version = "20.25.0" +version = "20.25.1" description = "Virtual Python Environment builder" optional = true python-versions = ">=3.7" files = [ - {file = "virtualenv-20.25.0-py3-none-any.whl", hash = "sha256:4238949c5ffe6876362d9c0180fc6c3a824a7b12b80604eeb8085f2ed7460de3"}, - {file = "virtualenv-20.25.0.tar.gz", hash = "sha256:bf51c0d9c7dd63ea8e44086fa1e4fb1093a31e963b86959257378aef020e1f1b"}, + {file = "virtualenv-20.25.1-py3-none-any.whl", hash = "sha256:961c026ac520bac5f69acb8ea063e8a4f071bcc9457b9c1f28f6b085c511583a"}, + {file = "virtualenv-20.25.1.tar.gz", hash = "sha256:e08e13ecdca7a0bd53798f356d5831434afa5b07b93f0abdf0797b7a06ffe197"}, ] [package.dependencies] @@ -5454,8 +5472,8 @@ docs = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "rst.link testing = ["big-O", "jaraco.functools", "jaraco.itertools", "more-itertools", "pytest (>=6)", "pytest-black (>=0.3.7)", "pytest-checkdocs (>=2.4)", "pytest-cov", "pytest-enabler (>=2.2)", "pytest-ignore-flaky", "pytest-mypy (>=0.9.1)", "pytest-ruff"] [extras] -dev = ["black", "cma", "coverage", "devsim", "dill", "gdspy", "gdstk", "gdstk", "grcwa", "ipython", "ipython", "jax", "jax", "jax", "jaxlib", "jaxlib", "jaxlib", "jinja2", "jupyter", "memory_profiler", "myst-parser", "nbconvert", "nbdime", "nbsphinx", "networkx", "optax", "pre-commit", "pydata-sphinx-theme", "pylint", "pyswarms", "pytest", "pytest-timeout", "rtree", "ruff", "sax", "signac", "sphinx", "sphinx-book-theme", "sphinx-copybutton", "sphinx-sitemap", "sphinx-tabs", "sphinxemoji", "tmm", "tox", "trimesh", "vtk"] -docs = ["cma", "devsim", "gdstk", "grcwa", "ipython", "jinja2", "jupyter", "myst-parser", "nbconvert", "nbdime", "nbsphinx", "optax", "pydata-sphinx-theme", "pylint", "sax", "signac", "sphinx", "sphinx-book-theme", "sphinx-copybutton", "sphinx-sitemap", "sphinx-tabs", "sphinxemoji", "tmm"] +dev = ["black", "cma", "coverage", "devsim", "dill", "gdspy", "gdstk", "gdstk", "grcwa", "ipython", "ipython", "jax", "jax", "jax", "jaxlib", "jaxlib", "jaxlib", "jinja2", "jupyter", "memory_profiler", "myst-parser", "nbconvert", "nbdime", "nbsphinx", "networkx", "optax", "pre-commit", "pydata-sphinx-theme", "pylint", "pyswarms", "pytest", "pytest-timeout", "rtree", "ruff", "sax", "signac", "sphinx", "sphinx-book-theme", "sphinx-copybutton", "sphinx-notfound-page", "sphinx-sitemap", "sphinx-tabs", "sphinxemoji", "tmm", "tox", "trimesh", "vtk"] +docs = ["cma", "devsim", "gdstk", "grcwa", "ipython", "jinja2", "jupyter", "myst-parser", "nbconvert", "nbdime", "nbsphinx", "optax", "pydata-sphinx-theme", "pylint", "sax", "signac", "sphinx", "sphinx-book-theme", "sphinx-copybutton", "sphinx-notfound-page", "sphinx-sitemap", "sphinx-tabs", "sphinxemoji", "tmm"] gdspy = ["gdspy"] gdstk = ["gdstk"] jax = ["jax", "jax", "jax", "jaxlib", "jaxlib", "jaxlib"] @@ -5465,4 +5483,4 @@ vtk = ["vtk"] [metadata] lock-version = "2.0" python-versions = ">=3.9,<3.12" -content-hash = "6054513ef08a158ae8295356f2ba99b39157ece4021a2cb4fb5aaed1cfe1ba32" +content-hash = "28b563bef2e6345fdc2ba84e5fa4b5a1bb0391cc7445908220616e45bc7351ed" diff --git a/pyproject.toml b/pyproject.toml index febaceb40..66218199e 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -93,6 +93,7 @@ pydata-sphinx-theme = {version = ">=0.13.3", optional = true} tmm = {version="*", optional = true} grcwa = {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} @@ -109,9 +110,9 @@ cma = {version="*", optional = true} dev = ['black', "coverage", 'dill', 'divparams', 'gdspy', 'gdstk', 'gdstk', 'grcwa', 'ipython', 'ipython', 'jax', 'jaxlib', 'jinja2', 'jupyter', 'jupyterblack', 'myst-parser', 'memory_profiler', 'nbconvert', 'nbdime', 'nbsphinx', 'networkx', 'optax', 'pre-commit', 'pydata-sphinx-theme', 'pylint', 'pyswarms', 'pytest', 'pytest-timeout', 'rtree', 'ruff', 'sax', 'signac', 'sphinx', - 'sphinx-book-theme', 'sphinx-copybutton', 'sphinx-sitemap', 'sphinx-tabs', 'sphinxemoji', 'tmm', 'tox', 'trimesh', + 'sphinx-book-theme', 'sphinx-copybutton', 'sphinx-notfound-page', 'sphinx-sitemap', 'sphinx-tabs', 'sphinxemoji', 'tmm', 'tox', 'trimesh', 'vtk', 'devsim', 'cma'] -docs = ["jupyter", "jinja2", "nbconvert", "sphinx", "nbsphinx", "ipython", "divparams", "sphinx-copybutton", "sphinx-book-theme", "pydata-sphinx-theme", "tmm", "gdstk", "grcwa", "sphinx-sitemap", "nbdime", "optax", "signac", "sax", "pylint", "jupyterblack", "sphinx-tabs", "sphinxemoji", "myst-parser", "devsim", "cma"] +docs = ["jupyter", "jinja2", "nbconvert", "sphinx", "nbsphinx", "ipython", "divparams", "sphinx-copybutton", "sphinx-book-theme", "pydata-sphinx-theme", "tmm", "gdstk", "grcwa", "sphinx-sitemap", 'sphinx-notfound-page', "nbdime", "optax", "signac", "sax", "pylint", "jupyterblack", "sphinx-tabs", "sphinxemoji", "myst-parser", "devsim", "cma"] gdspy = ["gdspy"] gdstk = ["gdstk"] jax = ["jaxlib", "jax"]