https://github.com/flexcompute/project-template

Template for a common python interface between Flexcompute APIs.
https://github.com/flexcompute/project-template

Last synced: 5 months ago
JSON representation

Template for a common python interface between Flexcompute APIs.

• Host: GitHub
• URL: https://github.com/flexcompute/project-template
• Owner: flexcompute
• License: lgpl-2.1
• Created: 2024-02-22T13:31:11.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-02-22T13:56:15.000Z (over 2 years ago)
• Last Synced: 2025-10-23T06:31:34.347Z (8 months ago)
• Size: 132 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Flexcompute Example Project

Replace the tags below with your own project. Left there for reference.

[![PyPI

Name](https://img.shields.io/badge/pypi-tidy3d-blue?style=for-the-badge)](https://pypi.python.org/pypi/tidy3d)

[![PyPI version shields.io](https://img.shields.io/pypi/v/tidy3d.svg?style=for-the-badge)](https://pypi.python.org/pypi/tidy3d/)

[![Documentation Status](https://readthedocs.com/projects/flexcompute-tidy3ddocumentation/badge/?version=latest&style=for-the-badge)](https://flexcompute-tidy3ddocumentation.readthedocs-hosted.com/?badge=latest)

![Tests](https://img.shields.io/github/actions/workflow/status/flexcompute/tidy3d/run_tests.yml?style=for-the-badge)

![License](https://img.shields.io/github/license/flexcompute/tidy3d?style=for-the-badge)

[![Black](https://img.shields.io/badge/code%20style-black-000000.svg?style=for-the-badge)](https://github.com/psf/black)

![Coverage](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/daquinteroflex/4702549574741e87deaadba436218ebd/raw/tidy3d_extension.json)

[![Notebooks](https://img.shields.io/badge/Demo-Live%20notebooks-8A2BE2?style=for-the-badge)](https://github.com/flexcompute/tidy3d-notebooks)

![](https://raw.githubusercontent.com/flexcompute/tidy3d/main/img/Tidy3D-logo.svg)

Some description of the project

![](https://raw.githubusercontent.com/flexcompute/tidy3d/main/img/snippet.png)

## Installation

## Common Documentation References

| API Resource       | URL                                                                              |

|--------------------|----------------------------------------------------------------------------------|

| Installation Guide | https://docs.flexcompute.com/projects/tidy3d/en/latest/install.html              |

| Documentation      | https://docs.flexcompute.com/projects/tidy3d/en/latest/index.html                |

| Example Library    | https://docs.flexcompute.com/projects/tidy3d/en/latest/notebooks/docs/index.html |

| FAQ                | https://docs.flexcompute.com/projects/tidy3d/en/latest/faq/docs/index.html       |

## Related Source Repositories

| Name              | Repository                                      |

|-------------------|-------------------------------------------------|

| Source Code       | https://github.com/flexcompute/tidy3d           |

| Notebooks Source  | https://github.com/flexcompute/tidy3d-notebooks |

| FAQ Source Code   | https://github.com/flexcompute/tidy3d-faq       |

## 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)