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 Tidy3d.

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 tidy3d is through pip.

pip install tidy3d

This will install the latest stable version, to get the a "pre-release" version.

pip install --pre tidy3d

And to get a specific version x.y.z

pip install tidy3d==x.y.z

Pre-release 1.9.0rc1 introduces the adjoint plugin, which uses jax for automatic differentiation of tidy3d simulations. As windows users may have trouble installing jax, the recommended approach is to use jax-windows-builder to first install jaxlib before tidy3d.

pip install "jax[cpu]===0.3.14" -f https://whls.blob.core.windows.net/unstable/index.html --use-deprecated legacy-resolver
pip install tidy3d

More details can be found here.

For development purposes, and to get the latest development versions, you can download and install the package from source as:

git clone https://github.com/flexcompute/tidy3d.git
cd tidy3d
pip install -e .

Authentication (linking the front end to your account) will be done via an API key moving forward.

You can find your API key in the web interface http://tidy3d.simulation.cloud

After signing in, copy the API key for the next steps.

To set up the API key to work with Tidy3D, we need to store it either in the ~/.tidy3d/config file or an environment variable.

You can set it up using one of three following options.

tidy3d configure and then enter your API key when prompted.

For an API key of {your_api_key}, you may run

echo 'apikey = "{your_api_key}"' > ~/.tidy3d/config

or manually insert the line 'apikey = "{your_api_key}" in the ~/.tidy3d/config file.

Set the SIMCLOUD_API_KEY environment variable to your API key (in quotes).

export SIMCLOUD_API_KEY="{your_api_key}"

You can verify the front end 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

To test the web / authentication

python -c "import tidy3d.web"

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.

GNU LGPL