Metadata-Version: 2.4
Name: pypalace
Version: 0.1.0
Summary: A Python toolkit for superconducting circuit design and simulation workflows using AWS Palace.
Author: Firas Abouzahr
License: MIT License
        
        Copyright (c) 2026 Firas Abouzahr
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/FirasAbouzahr/pyPalace
Project-URL: Repository, https://github.com/FirasAbouzahr/pyPalace
Project-URL: Issues, https://github.com/FirasAbouzahr/pyPalace/issues
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.20
Requires-Dist: pandas>=1.5
Requires-Dist: scqubits>=3.0
Requires-Dist: matplotlib>=3.5
Requires-Dist: pyvista>=0.40
Requires-Dist: scipy>=1.7
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Dynamic: license-file

# pyPalace 

[![Docs](https://img.shields.io/badge/docs-live-blue)](https://firasabouzahr.github.io/pyPalace/)

pyPalace is a Python toolkit for streamlining [AWS Palace](https://awslabs.github.io/palace/stable/) electromagnetic simulations for the design and modeling of superconducting quantum devices.

At the top-level, pyPalace is a python wrapper around AWS Palace. It enables users to:
- build Palace configuration files,
- run simulations (locally or on HPC systems),
- visualize computed electromagnetic fields,
- and extract simulation results cleanly.

For superconducting devices, pyPalace includes quantum analysis tools such as Lumped Oscillator Modeling (LOM), Energy Participation Ratio (EPR) methods, and other techniques to extract important physical parameters.

For questions, comments, or collaboration, contact:  
[firasabouzahr2030@u.northwestern.edu](mailto:firasabouzahr2030@u.northwestern.edu)

---

## Installation

> **Note:** pyPalace requires AWS Palace to be installed separately.

Clone the repository:

    cd <your_directory>
    git clone https://github.com/FirasAbouzahr/pyPalace.git
    cd pyPalace

Install locally:

    pip install -e .

---

## Examples

Examples can be found in the [examples](Examples) directory.

* Example 00 (Introduction to pyPalace - **coming soon**)
* [Example 01](Examples/example_01_eigenmode_EPR) (eigenmode simulations & EPR analysis of a qubit-cavity system)
* [Example 02](Examples/example_02_electrostatics_LOM) (electrostatic simulations & LOM analysis of Transmon qubits)
* [Example 03](Examples/example_03_fdomain_driven_resonator) (driven simulation of a resonator & DCM fitting to S21)

---

## License
This project is licensed under the MIT License – see the [LICENSE](LICENSE) file for details.
