{"id":50964569,"url":"https://github.com/flexcompute/tidy3d-docs","last_synced_at":"2026-06-18T18:30:40.225Z","repository":{"id":38331245,"uuid":"452803618","full_name":"flexcompute/tidy3d-docs","owner":"flexcompute","description":"Documentation for Tidy3D","archived":false,"fork":false,"pushed_at":"2026-02-19T18:30:07.000Z","size":867312,"stargazers_count":10,"open_issues_count":1,"forks_count":10,"subscribers_count":1,"default_branch":"develop","last_synced_at":"2026-05-02T16:38:13.947Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://docs.simulation.cloud/projects/tidy3d/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-2.1","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/flexcompute.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":"COPYRIGHT","agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2022-01-27T18:45:49.000Z","updated_at":"2026-04-22T16:24:06.000Z","dependencies_parsed_at":"2024-02-26T10:55:54.812Z","dependency_job_id":"d7fa08b5-a3c1-496d-8c5d-b8e6cc0b7d3a","html_url":"https://github.com/flexcompute/tidy3d-docs","commit_stats":null,"previous_names":["flexcompute/tidy3d-docs"],"tags_count":115,"template":false,"template_full_name":null,"purl":"pkg:github/flexcompute/tidy3d-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flexcompute%2Ftidy3d-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flexcompute%2Ftidy3d-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flexcompute%2Ftidy3d-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flexcompute%2Ftidy3d-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flexcompute","download_url":"https://codeload.github.com/flexcompute/tidy3d-docs/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flexcompute%2Ftidy3d-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34503507,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-18T02:00:06.871Z","response_time":128,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-06-18T18:30:39.278Z","updated_at":"2026-06-18T18:30:40.213Z","avatar_url":"https://github.com/flexcompute.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Tidy3D\n[![PyPI\nName](https://img.shields.io/badge/pypi-tidy3d-blue?style=for-the-badge)](https://pypi.python.org/pypi/tidy3d)\n[![PyPI version shields.io](https://img.shields.io/pypi/v/tidy3d.svg?style=for-the-badge)](https://pypi.python.org/pypi/tidy3d/)\n[![Documentation Status](https://readthedocs.com/projects/flexcompute-tidy3ddocumentation/badge/?version=latest\u0026style=for-the-badge)](https://flexcompute-tidy3ddocumentation.readthedocs-hosted.com/?badge=latest)\n[![Tests](https://img.shields.io/github/actions/workflow/status/flexcompute/tidy3d/tidy3d-python-client-tests.yml?branch=develop\u0026style=for-the-badge)](https://github.com/flexcompute/tidy3d/actions/workflows/tidy3d-python-client-tests.yml)\n[![License: LGPL-2.1](https://img.shields.io/badge/license-LGPL--2.1-blue?style=for-the-badge)](LICENSE)\n[![Ruff](https://img.shields.io/badge/code%20style-ruff-5A4FCF?style=for-the-badge)](https://github.com/astral-sh/ruff)\n![Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/daquinteroflex/4702549574741e87deaadba436218ebd/raw/tidy3d_extension.json)\n\n[![Notebooks](https://img.shields.io/badge/Demo-Live%20notebooks-8A2BE2?style=for-the-badge)](https://github.com/flexcompute/tidy3d-notebooks)\n\n![](https://raw.githubusercontent.com/flexcompute/tidy3d/main/img/Tidy3D-logo.svg)\n\nTidy3D is a software package for solving extremely large electrodynamics problems using the finite-difference time-domain (FDTD) method. It can be controlled through either an [open source python package](https://github.com/flexcompute/tidy3d) or a [web-based graphical user interface](https://tidy3d.simulation.cloud).\n\nThis repository contains the python API to allow you to:\n\n* Programmatically define FDTD simulations.\n* Submit and manage simulations running on Flexcompute's servers.\n* Download and postprocess the results from the simulations.\n\n![](https://raw.githubusercontent.com/flexcompute/tidy3d/main/img/snippet.png)\n\n## Installation\n\n### Signing up for tidy3d\n\nNote that while this front end package is open source, to run simulations on Flexcompute servers requires an account with credits.\nYou can sign up for an account [here](https://tidy3d.simulation.cloud/signup).\nAfter that, you can install the front end with the instructions below, or visit [this page](https://docs.flexcompute.com/projects/tidy3d/en/latest/install.html) in our documentation for more details.\n\n### Quickstart Installation\n\nTo install the Tidy3D Python API locally, the following instructions should work for most users.\n\n```\npip install --user tidy3d\ntidy3d configure --apikey=XXX\n```\n\nWhere `XXX` is your API key, which can be copied from your [account page](https://tidy3d.simulation.cloud/account) in the web interface.\n\nIn a hosted jupyter notebook environment (eg google colab), it may be more convenient to install and configure via the following lines at the top of the notebook.\n\n```\n!pip install tidy3d\nimport tidy3d.web as web\nweb.configure(\"XXX\")\n```\n\n**Advanced installation instructions for all platforms is available in the [documentation installation guides](https://docs.flexcompute.com/projects/tidy3d/en/latest/install.html).**\n\n### Authentication Verification\n\nTo test the authentication, you may try importing the web interface via.\n\n```\npython -c \"import tidy3d; tidy3d.web.test()\"\n```\n\nIt should pass without any errors if the API key is set up correctly.\n\nTo get started, our documentation has a lot of [examples](https://docs.flexcompute.com/projects/tidy3d/en/latest/notebooks/docs/index.html) for inspiration.\n\n## Common Documentation References\n\n| API Resource       | URL                                                                              |\n|--------------------|----------------------------------------------------------------------------------|\n| Installation Guide | https://docs.flexcompute.com/projects/tidy3d/en/latest/install.html              |\n| Documentation      | https://docs.flexcompute.com/projects/tidy3d/en/latest/index.html                |\n| Example Library    | https://docs.flexcompute.com/projects/tidy3d/en/latest/notebooks/docs/index.html |\n| FAQ                | https://docs.flexcompute.com/projects/tidy3d/en/latest/faq/docs/index.html       |\n\n\n## FlexAgent MCP\n\nFlexAgent adds an AI-assisted layer on top of Tidy3D via the Model Context Protocol (MCP); read more about [AI-assisted simulation in Tidy3D](https://hs.flexcompute.com/news/ai-assisted-simulation-in-tidy3d-ushering-in-a-new-era-of-photonic-design). Install the `tidy3d-mcp` server when you want that experience inside an MCP client without the Tidy3D extension for [Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=ms-python.python) and [Cursor](https://open-vsx.org/extension/Flexcompute/tidy3d).\n\nThese commands assume [uv](https://docs.astral.sh/uv/getting-started/installation/) is installed on your machine.\n\n**Register the server with your MCP client** - use the block below that matches your CLI.\n\n\u003cdetails\u003e\n\u003csummary\u003eCodex CLI / IDE\u003c/summary\u003e\n\n```bash\ncodex mcp add tidy3d -- uvx tidy3d-mcp --api-key \"YOUR_TIDY3D_API_KEY\"\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eClaude CLI / Desktop / Code\u003c/summary\u003e\n\n```bash\nclaude mcp add tidy3d -- uvx tidy3d-mcp --api-key \"YOUR_TIDY3D_API_KEY\"\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eGemini CLI\u003c/summary\u003e\n\nCreate or edit `.gemini/settings.json` (project) or `~/.gemini/settings.json` (global):\n\n```json\n{\n  \"mcpServers\": {\n    \"tidy3d\": {\n      \"command\": \"uvx\",\n      \"args\": [\"tidy3d-mcp\", \"--api-key\", \"YOUR_TIDY3D_API_KEY\"]\n    }\n  }\n}\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003eCursor CLI / IDE\u003c/summary\u003e\n\nCursor reuses the same schema across the editor and `cursor-agent`. Configure `.cursor/mcp.json` (per-project) or `~/.cursor/mcp.json` (global) and then run `cursor-agent mcp list` to verify:\n\n```json\n{\n  \"mcpServers\": {\n    \"tidy3d\": {\n      \"command\": \"uvx\",\n      \"args\": [\"tidy3d-mcp\", \"--api-key\", \"YOUR_TIDY3D_API_KEY\"]\n    }\n  }\n}\n```\n\n\u003c/details\u003e\n\n\n## Related Source Repositories\n\n| Name              | Repository                                      |\n|-------------------|-------------------------------------------------|\n| Source Code       | https://github.com/flexcompute/tidy3d           |\n| Notebooks Source  | https://github.com/flexcompute/tidy3d-notebooks |\n| FAQ Source Code   | https://github.com/flexcompute/tidy3d-faq       |\n\n\n## Issues / Feedback / Bug Reporting\n\nYour feedback helps us immensely!\n\nIf you find bugs, file an [Issue](https://github.com/flexcompute/tidy3d/issues).\nFor more general discussions, questions, comments, anything else, open a topic in the [Discussions Tab](https://github.com/flexcompute/tidy3d/discussions).\n\n## License\n\n[GNU LGPL](https://github.com/flexcompute/tidy3d/blob/main/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflexcompute%2Ftidy3d-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflexcompute%2Ftidy3d-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflexcompute%2Ftidy3d-docs/lists"}