1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
|
%global _empty_manifest_terminate_build 0
Name: python-tidy3d
Version: 2.2.2
Release: 1
Summary: A fast FDTD solver
License: MIT License
URL: https://github.com/flexcompute/tidy3d
Source0: https://mirrors.aliyun.com/pypi/web/packages/33/d0/f39c9a46d5b038ab667f12ea498505154b256d85b8b2dfeccdbf2e0b415e/tidy3d-2.2.2.tar.gz
BuildArch: noarch
Requires: python3-scipy
Requires: python3-pyroots
Requires: python3-xarray
Requires: python3-importlib-metadata
Requires: python3-h5netcdf
Requires: python3-h5py
Requires: python3-rich
Requires: python3-matplotlib
Requires: python3-shapely
Requires: python3-pydantic
Requires: python3-PyYAML
Requires: python3-dask
Requires: python3-toml
Requires: python3-boto3
Requires: python3-requests
Requires: python3-pyjwt
Requires: python3-click
Requires: python3-responses
Requires: python3-typing-extensions
Requires: python3-pre-commit
Requires: python3-black
Requires: python3-pylint
Requires: python3-tox
Requires: python3-pytest
Requires: python3-pytest-timeout
Requires: python3-memory-profiler
Requires: python3-dill
Requires: python3-gdspy
Requires: python3-gdstk
Requires: python3-jaxlib
Requires: python3-jax[cpu]
Requires: python3-jaxlib
Requires: python3-jax[cpu]
Requires: python3-trimesh
Requires: python3-networkx
Requires: python3-rtree
%description
# Tidy3D
[](https://mybinder.org/v2/gh/flexcompute-readthedocs/tidy3d-docs/readthedocs?labpath=docs%2Fsource%2Fnotebooks)
[](https://flexcompute-tidy3ddocumentation.readthedocs-hosted.com/?badge=latest)
[](https://pypi.python.org/pypi/tidy3d/)
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](https://docs.flexcompute.com/projects/tidy3d/en/stable/).
The source code for our documentation is [here](https://github.com/flexcompute-readthedocs/tidy3d-docs).
## Installation
### Signing up for tidy3d
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 for an account [here](https://tidy3d.simulation.cloud/signup).
After that, you can install the front end with the instructions below, or visit [this page](https://docs.flexcompute.com/projects/tidy3d/en/stable/quickstart.html) in our documentation for more details.
### Installing the front end
To install the Tidy3D Python API locally, the following instructions should work for most users.
```
pip install --user tidy3d
tidy3d configure --apikey=XXX
```
Where `XXX` is your API key, which can be copied from your [account page](https://tidy3d.simulation.cloud/account) in the web interface.
In 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.
```
!pip install tidy3d
import tidy3d.web as web
web.configure("XXX")
```
If those commands did not work, advanced installation instructions are below, which should help solve the issue.
### Advanced Installation Instructions
Some users might require more a specialized installation, which we cover below.
#### Using pip (recommended)
The easiest way to install the tidy3d python interface is through [pip](https://pypi.org/project/tidy3d/).
```
pip install tidy3d
```
This will install the latest stable version.
To get a specific version `x.y.z`, including the "pre-release" versions, you may specify the version in the command as:
```
pip install tidy3d==x.y.z
```
### Installing from source
Alternatively, for development purposes, eg. developing your own features, you may download and install the package from source as:
```
git clone https://github.com/flexcompute/tidy3d.git
cd tidy3d
pip install -e .
```
### Configuring and authentication
With the front end installed, it must now be configured with your account information, which is done via an "API key".
You can find your API key in the [web interface](http://tidy3d.simulation.cloud). After signing in and navigating to the account page by clicking the "Account Center" icon on the left-hand side. Then, click on the "API key" tab on the right hand side of the menu and copy your API key.
Note: We refer to your API specific API key value as `XXX` below.
To link your API key with Tidy3D, you may use one of three following options:
#### Command line (recommended)
The easiest way is through the command line via the `tidy3d configure` command. Run:
```
tidy3d configure
```
and then enter your API key `XXX` when prompted.
Note that Windows users must run the following instead (ideally in an anaconda prompt):
```
pip install pipx
pipx run tidy3d configure
```
You can also specify your API key directly as an option to this command using the `api-key` argument, for example:
```
tidy3d configure --apikey=XXX
```
#### Manually
Alternatively, you can manually set up the config file where Tidy3D looks for the API key. The API key must be in a file called `.tidy3d/config` located in your home directory, containing the following
```
apikey = "XXX"
```
You can manually set up your file like this, or do it through the command line line:
``echo 'apikey = "XXX"' > ~/.tidy3d/config``
Note the quotes around `XXX`.
Note that Windows users will most likely need to place the `.tidy3d/config` file in their `C:\Users\username\` directory (where `username` is your username).
#### Environment Variable
Lastly, you may set the API key as an environment variable named `SIMCLOUD_APIKEY`.
This can be set up using
``export SIMCLOUD_APIKEY="XXX"``
Note the quotes around `XXX`.
### Testing the installation and authentication
#### Front end package
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:
```
2.0.0
```
#### Authentication
To test the authentication, you may try importing the web interface via.
```
python -c "import tidy3d.web"
```
It should pass without any errors if the API key is set up correctly.
To get started, our documentation has a lot of [examples](https://docs.flexcompute.com/projects/tidy3d/en/latest/examples.html) for inspiration.
## Issues / Feedback / Bug Reporting
Your feedback helps us immensely!
If you find bugs, file an [Issue](https://github.com/flexcompute/tidy3d/issues).
For more general discussions, questions, comments, anything else, open a topic in the [Discussions Tab](https://github.com/flexcompute/tidy3d/discussions).
## License
[GNU LGPL](https://github.com/flexcompute/tidy3d/blob/main/LICENSE)
%package -n python3-tidy3d
Summary: A fast FDTD solver
Provides: python-tidy3d
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-tidy3d
# Tidy3D
[](https://mybinder.org/v2/gh/flexcompute-readthedocs/tidy3d-docs/readthedocs?labpath=docs%2Fsource%2Fnotebooks)
[](https://flexcompute-tidy3ddocumentation.readthedocs-hosted.com/?badge=latest)
[](https://pypi.python.org/pypi/tidy3d/)
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](https://docs.flexcompute.com/projects/tidy3d/en/stable/).
The source code for our documentation is [here](https://github.com/flexcompute-readthedocs/tidy3d-docs).
## Installation
### Signing up for tidy3d
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 for an account [here](https://tidy3d.simulation.cloud/signup).
After that, you can install the front end with the instructions below, or visit [this page](https://docs.flexcompute.com/projects/tidy3d/en/stable/quickstart.html) in our documentation for more details.
### Installing the front end
To install the Tidy3D Python API locally, the following instructions should work for most users.
```
pip install --user tidy3d
tidy3d configure --apikey=XXX
```
Where `XXX` is your API key, which can be copied from your [account page](https://tidy3d.simulation.cloud/account) in the web interface.
In 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.
```
!pip install tidy3d
import tidy3d.web as web
web.configure("XXX")
```
If those commands did not work, advanced installation instructions are below, which should help solve the issue.
### Advanced Installation Instructions
Some users might require more a specialized installation, which we cover below.
#### Using pip (recommended)
The easiest way to install the tidy3d python interface is through [pip](https://pypi.org/project/tidy3d/).
```
pip install tidy3d
```
This will install the latest stable version.
To get a specific version `x.y.z`, including the "pre-release" versions, you may specify the version in the command as:
```
pip install tidy3d==x.y.z
```
### Installing from source
Alternatively, for development purposes, eg. developing your own features, you may download and install the package from source as:
```
git clone https://github.com/flexcompute/tidy3d.git
cd tidy3d
pip install -e .
```
### Configuring and authentication
With the front end installed, it must now be configured with your account information, which is done via an "API key".
You can find your API key in the [web interface](http://tidy3d.simulation.cloud). After signing in and navigating to the account page by clicking the "Account Center" icon on the left-hand side. Then, click on the "API key" tab on the right hand side of the menu and copy your API key.
Note: We refer to your API specific API key value as `XXX` below.
To link your API key with Tidy3D, you may use one of three following options:
#### Command line (recommended)
The easiest way is through the command line via the `tidy3d configure` command. Run:
```
tidy3d configure
```
and then enter your API key `XXX` when prompted.
Note that Windows users must run the following instead (ideally in an anaconda prompt):
```
pip install pipx
pipx run tidy3d configure
```
You can also specify your API key directly as an option to this command using the `api-key` argument, for example:
```
tidy3d configure --apikey=XXX
```
#### Manually
Alternatively, you can manually set up the config file where Tidy3D looks for the API key. The API key must be in a file called `.tidy3d/config` located in your home directory, containing the following
```
apikey = "XXX"
```
You can manually set up your file like this, or do it through the command line line:
``echo 'apikey = "XXX"' > ~/.tidy3d/config``
Note the quotes around `XXX`.
Note that Windows users will most likely need to place the `.tidy3d/config` file in their `C:\Users\username\` directory (where `username` is your username).
#### Environment Variable
Lastly, you may set the API key as an environment variable named `SIMCLOUD_APIKEY`.
This can be set up using
``export SIMCLOUD_APIKEY="XXX"``
Note the quotes around `XXX`.
### Testing the installation and authentication
#### Front end package
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:
```
2.0.0
```
#### Authentication
To test the authentication, you may try importing the web interface via.
```
python -c "import tidy3d.web"
```
It should pass without any errors if the API key is set up correctly.
To get started, our documentation has a lot of [examples](https://docs.flexcompute.com/projects/tidy3d/en/latest/examples.html) for inspiration.
## Issues / Feedback / Bug Reporting
Your feedback helps us immensely!
If you find bugs, file an [Issue](https://github.com/flexcompute/tidy3d/issues).
For more general discussions, questions, comments, anything else, open a topic in the [Discussions Tab](https://github.com/flexcompute/tidy3d/discussions).
## License
[GNU LGPL](https://github.com/flexcompute/tidy3d/blob/main/LICENSE)
%package help
Summary: Development documents and examples for tidy3d
Provides: python3-tidy3d-doc
%description help
# Tidy3D
[](https://mybinder.org/v2/gh/flexcompute-readthedocs/tidy3d-docs/readthedocs?labpath=docs%2Fsource%2Fnotebooks)
[](https://flexcompute-tidy3ddocumentation.readthedocs-hosted.com/?badge=latest)
[](https://pypi.python.org/pypi/tidy3d/)
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](https://docs.flexcompute.com/projects/tidy3d/en/stable/).
The source code for our documentation is [here](https://github.com/flexcompute-readthedocs/tidy3d-docs).
## Installation
### Signing up for tidy3d
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 for an account [here](https://tidy3d.simulation.cloud/signup).
After that, you can install the front end with the instructions below, or visit [this page](https://docs.flexcompute.com/projects/tidy3d/en/stable/quickstart.html) in our documentation for more details.
### Installing the front end
To install the Tidy3D Python API locally, the following instructions should work for most users.
```
pip install --user tidy3d
tidy3d configure --apikey=XXX
```
Where `XXX` is your API key, which can be copied from your [account page](https://tidy3d.simulation.cloud/account) in the web interface.
In 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.
```
!pip install tidy3d
import tidy3d.web as web
web.configure("XXX")
```
If those commands did not work, advanced installation instructions are below, which should help solve the issue.
### Advanced Installation Instructions
Some users might require more a specialized installation, which we cover below.
#### Using pip (recommended)
The easiest way to install the tidy3d python interface is through [pip](https://pypi.org/project/tidy3d/).
```
pip install tidy3d
```
This will install the latest stable version.
To get a specific version `x.y.z`, including the "pre-release" versions, you may specify the version in the command as:
```
pip install tidy3d==x.y.z
```
### Installing from source
Alternatively, for development purposes, eg. developing your own features, you may download and install the package from source as:
```
git clone https://github.com/flexcompute/tidy3d.git
cd tidy3d
pip install -e .
```
### Configuring and authentication
With the front end installed, it must now be configured with your account information, which is done via an "API key".
You can find your API key in the [web interface](http://tidy3d.simulation.cloud). After signing in and navigating to the account page by clicking the "Account Center" icon on the left-hand side. Then, click on the "API key" tab on the right hand side of the menu and copy your API key.
Note: We refer to your API specific API key value as `XXX` below.
To link your API key with Tidy3D, you may use one of three following options:
#### Command line (recommended)
The easiest way is through the command line via the `tidy3d configure` command. Run:
```
tidy3d configure
```
and then enter your API key `XXX` when prompted.
Note that Windows users must run the following instead (ideally in an anaconda prompt):
```
pip install pipx
pipx run tidy3d configure
```
You can also specify your API key directly as an option to this command using the `api-key` argument, for example:
```
tidy3d configure --apikey=XXX
```
#### Manually
Alternatively, you can manually set up the config file where Tidy3D looks for the API key. The API key must be in a file called `.tidy3d/config` located in your home directory, containing the following
```
apikey = "XXX"
```
You can manually set up your file like this, or do it through the command line line:
``echo 'apikey = "XXX"' > ~/.tidy3d/config``
Note the quotes around `XXX`.
Note that Windows users will most likely need to place the `.tidy3d/config` file in their `C:\Users\username\` directory (where `username` is your username).
#### Environment Variable
Lastly, you may set the API key as an environment variable named `SIMCLOUD_APIKEY`.
This can be set up using
``export SIMCLOUD_APIKEY="XXX"``
Note the quotes around `XXX`.
### Testing the installation and authentication
#### Front end package
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:
```
2.0.0
```
#### Authentication
To test the authentication, you may try importing the web interface via.
```
python -c "import tidy3d.web"
```
It should pass without any errors if the API key is set up correctly.
To get started, our documentation has a lot of [examples](https://docs.flexcompute.com/projects/tidy3d/en/latest/examples.html) for inspiration.
## Issues / Feedback / Bug Reporting
Your feedback helps us immensely!
If you find bugs, file an [Issue](https://github.com/flexcompute/tidy3d/issues).
For more general discussions, questions, comments, anything else, open a topic in the [Discussions Tab](https://github.com/flexcompute/tidy3d/discussions).
## License
[GNU LGPL](https://github.com/flexcompute/tidy3d/blob/main/LICENSE)
%prep
%autosetup -n tidy3d-2.2.2
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "\"/%h/%f\"\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "\"/%h/%f.gz\"\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-tidy3d -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Thu Jun 08 2023 Python_Bot <Python_Bot@openeuler.org> - 2.2.2-1
- Package Spec generated
|
