Tidy3D is a software product from Flexcompute that enables large scale electromagnetic simulation using the finite-difference time-domain (FDTD) method.
This repository stores the python interface for the beta release of Tidy3D that will be officially released to the public in early 2022.
This code allows you to:
- Programmatically define FDTD simulations.
- Submit and magange simulations running on Flexcompute's servers.
- Download and postprocess the results from the simulations.
You can find a detailed documentation and API reference here. The source code for our documentation is here.
Note that while this front end package is open source, to run simulations on Flexcompute servers requires an account with credits. You can sign up here. While it's currently a waitlist for new users, we will be rolling out to many more users in the coming weeks! See this page in our documentation for more details.
The easiest way to install this beta version of tidy3d is through pip.
pip install tidy3d-beta
Note that while our old version is still currently pip installable as tidy3d, both versions are imoprted in python as tidy3d, eg. import tidy3d as td.
For development purposes, you can download and install the package from source as:
git clone https://github.com/flexcompute/tidy3d.git
cd tidy3d
pip install -e .
You can verify the installation worked by running:
python -c "import tidy3d as td; print(td.__version__)"
and it should print out the version number, for example:
1.0.0
This is a beta release and your feedback helps us immensely!
If you find bugs, file an Issue. For more general discussions, questions, comments, anything else, open a topic in the Discussions Tab.