diff options
author | CoprDistGit <infra@openeuler.org> | 2023-05-10 08:49:02 +0000 |
---|---|---|
committer | CoprDistGit <infra@openeuler.org> | 2023-05-10 08:49:02 +0000 |
commit | b52ce8ad7131d17c57e86d4ea0f2aee86f84302e (patch) | |
tree | 62099ca13a92f7dccdf3198cc5499e499a76d745 | |
parent | e685dfcfa0906b9cc64442ce34b55c103af32e7e (diff) |
automatic import of python-tidy3d
-rw-r--r-- | .gitignore | 1 | ||||
-rw-r--r-- | python-tidy3d.spec | 645 | ||||
-rw-r--r-- | sources | 1 |
3 files changed, 647 insertions, 0 deletions
@@ -0,0 +1 @@ +/tidy3d-2.1.1.tar.gz diff --git a/python-tidy3d.spec b/python-tidy3d.spec new file mode 100644 index 0000000..e7a2d19 --- /dev/null +++ b/python-tidy3d.spec @@ -0,0 +1,645 @@ +%global _empty_manifest_terminate_build 0 +Name: python-tidy3d +Version: 2.1.1 +Release: 1 +Summary: A fast FDTD solver +License: MIT License +URL: https://github.com/flexcompute/tidy3d +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/b2/02/987eb29138b8eaaba8fff794fd1d1f321205414de391a98a7d72d3ab4754/tidy3d-2.1.1.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-nest-asyncio +Requires: python3-boto3 +Requires: python3-requests +Requires: python3-pyjwt +Requires: python3-click +Requires: python3-responses +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.1.1 + +%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 +* Wed May 10 2023 Python_Bot <Python_Bot@openeuler.org> - 2.1.1-1 +- Package Spec generated @@ -0,0 +1 @@ +6dcdc9efb9270f557a3f619524d84006 tidy3d-2.1.1.tar.gz |