{"id":13736439,"url":"https://github.com/flexcompute/tidy3d","last_synced_at":"2025-04-04T15:10:14.018Z","repository":{"id":37022844,"uuid":"392106790","full_name":"flexcompute/tidy3d","owner":"flexcompute","description":"Fast electromagnetic solver (FDTD) at scale.","archived":false,"fork":false,"pushed_at":"2024-05-22T18:18:33.000Z","size":797990,"stargazers_count":153,"open_issues_count":132,"forks_count":38,"subscribers_count":6,"default_branch":"develop","last_synced_at":"2024-05-22T18:52:01.739Z","etag":null,"topics":["electromagnetics","fdtd","pydantic","python","simulation","xarray"],"latest_commit_sha":null,"homepage":"https://www.flexcompute.com/tidy3d/solver/","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":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-08-02T22:04:45.000Z","updated_at":"2024-05-27T11:45:48.725Z","dependencies_parsed_at":"2024-01-01T05:23:02.772Z","dependency_job_id":"ead15391-dbb1-4730-a882-f156164ba840","html_url":"https://github.com/flexcompute/tidy3d","commit_stats":{"total_commits":1295,"total_committers":22,"mean_commits":58.86363636363637,"dds":0.6270270270270271,"last_synced_commit":"027b422b84deb79446a013da4e6ebbb8dc0a2bdd"},"previous_names":[],"tags_count":77,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flexcompute%2Ftidy3d","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flexcompute%2Ftidy3d/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flexcompute%2Ftidy3d/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/flexcompute%2Ftidy3d/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/flexcompute","download_url":"https://codeload.github.com/flexcompute/tidy3d/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247198463,"owners_count":20900080,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["electromagnetics","fdtd","pydantic","python","simulation","xarray"],"created_at":"2024-08-03T03:01:21.808Z","updated_at":"2025-04-04T15:10:14.002Z","avatar_url":"https://github.com/flexcompute.png","language":"Python","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/run_tests.yml?style=for-the-badge)\n![License](https://img.shields.io/github/license/flexcompute/tidy3d?style=for-the-badge)\n[![Black](https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge)](https://github.com/psf/black)\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\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## 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","funding_links":[],"categories":["simulation"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflexcompute%2Ftidy3d","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflexcompute%2Ftidy3d","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflexcompute%2Ftidy3d/lists"}