sqil-core 0.0.1__tar.gz → 0.1.0__tar.gz

{sqil_core-0.0.1 → sqil_core-0.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: sqil-core
-Version: 0.0.1
+Version: 0.1.0
 Summary: The codebase of the SQIL group in EPFL
 Author: Andrea Duina
 Requires-Python: >=3.10,<4.0
@@ -11,10 +11,11 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Requires-Dist: h5py (>=3.12.1,<4.0.0)
 Requires-Dist: isort (==5.9.3)
+Requires-Dist: lmfit (>=1.3.2,<2.0.0)
 Requires-Dist: matplotlib (>=3.9.3,<4.0.0)
-Requires-Dist: numpy (>=2.2.0,<3.0.0)
+Requires-Dist: numpy (>=2.2.3,<3.0.0)
 Requires-Dist: scipy (>=1.14.1,<2.0.0)
-Requires-Dist: seaborn (>=0.13.2,<0.14.0)
+Requires-Dist: tabulate (>=0.9.0,<0.10.0)
 Description-Content-Type: text/markdown
 
 # For users
@@ -38,34 +39,44 @@ path = 'path to your data folder'
 mag, phase, freq = sqil.extract_h5_data(path, ['mag_dB', 'phase', 'ro_freq'])
 ```
 
+## Documentation
+You can find the documentation for this package [here](https://sqil-epfl.github.io/sqil-core/)
+
 # For developers
 
 ## Development
 
 1. **Install poetry if you haven't already**
+
 ```bash
 $ pip install poetry
+$ pip install poetry-plugin-shell
 ```
 
 2. **Install the required packages using poetry**
+
 ```bash
 $ poetry install
 ```
 
 3. **Install the pre-commit hooks**
-If you are on windows you need to install git ([https://git-scm.com/downloads](here)) and add it to your windows PATH.
-After the installation open a new terminal.
+   If you are on windows you need to install git ([https://git-scm.com/downloads](here)) and add it to your windows PATH.
+   After the installation open a new terminal.
+
 ```bash
 $ poetry run pre-commit install
 ```
+
 This will check if your python files are formatted correctly when you try to commit.
 If that's not the case the commit will be canceled and the files will be automatically formatted.
 Then you'll have to add and commit again the new files.
 
 4. **Start the virtual environment**
+
 ```bash
 $ poetry shell
 ```
+
 To exit the virtual environment just use `exit`
 
 #### Test your changes
@@ -91,7 +102,11 @@ $ poetry run build
 $ pip install PATH_TO_SQIL_CORE_FOLDER/dist/SQIL_CORE-VERSION.whl
 ```
 
-If you're using a jupyter notebook remember to restart the kernel
+If you're testing a new function remember to import it in the folder's `__init__.py` file.
+
+
+If you're using a jupyter notebook remember to restart the kernel.
+
 
 ## Build
 
@@ -99,6 +114,16 @@ If you're using a jupyter notebook remember to restart the kernel
 $ poetry run build
 ```
 
+## Publish
+
+To publish version X.X.X run the commands below. This will trigger a GitHub action that deploys to release to PyPi (pip) and GitHub.
+Remember also to change the version number in the `pyproject.toml` file.
+
+```bash
+$ git tag vX.X.X
+$ git push origin vX.X.X
+```
+
 ## Docs
 
 Serve docs

{sqil_core-0.0.1 → sqil_core-0.1.0}/README.md

@@ -19,34 +19,44 @@ path = 'path to your data folder'
 mag, phase, freq = sqil.extract_h5_data(path, ['mag_dB', 'phase', 'ro_freq'])
 ```
 
+## Documentation
+You can find the documentation for this package [here](https://sqil-epfl.github.io/sqil-core/)
+
 # For developers
 
 ## Development
 
 1. **Install poetry if you haven't already**
+
 ```bash
 $ pip install poetry
+$ pip install poetry-plugin-shell
 ```
 
 2. **Install the required packages using poetry**
+
 ```bash
 $ poetry install
 ```
 
 3. **Install the pre-commit hooks**
-If you are on windows you need to install git ([https://git-scm.com/downloads](here)) and add it to your windows PATH.
-After the installation open a new terminal.
+   If you are on windows you need to install git ([https://git-scm.com/downloads](here)) and add it to your windows PATH.
+   After the installation open a new terminal.
+
 ```bash
 $ poetry run pre-commit install
 ```
+
 This will check if your python files are formatted correctly when you try to commit.
 If that's not the case the commit will be canceled and the files will be automatically formatted.
 Then you'll have to add and commit again the new files.
 
 4. **Start the virtual environment**
+
 ```bash
 $ poetry shell
 ```
+
 To exit the virtual environment just use `exit`
 
 #### Test your changes
@@ -72,7 +82,11 @@ $ poetry run build
 $ pip install PATH_TO_SQIL_CORE_FOLDER/dist/SQIL_CORE-VERSION.whl
 ```
 
-If you're using a jupyter notebook remember to restart the kernel
+If you're testing a new function remember to import it in the folder's `__init__.py` file.
+
+
+If you're using a jupyter notebook remember to restart the kernel.
+
 
 ## Build
 
@@ -80,6 +94,16 @@ If you're using a jupyter notebook remember to restart the kernel
 $ poetry run build
 ```
 
+## Publish
+
+To publish version X.X.X run the commands below. This will trigger a GitHub action that deploys to release to PyPi (pip) and GitHub.
+Remember also to change the version number in the `pyproject.toml` file.
+
+```bash
+$ git tag vX.X.X
+$ git push origin vX.X.X
+```
+
 ## Docs
 
 Serve docs

{sqil_core-0.0.1 → sqil_core-0.1.0}/pyproject.toml

@@ -1,23 +1,24 @@
 [tool.poetry]
 name = "sqil-core"
-version = "0.0.1"
+version = "v0.1.0"
 description = "The codebase of the SQIL group in EPFL"
 authors = ["Andrea Duina"]
 readme = "README.md"
 
 [tool.poetry.scripts]
 build = "scripts:build"
-docs-serve = "scripts:docs_serve"
+docs-dev = "scripts:docs_dev"
 docs-build = "scripts:docs_build"
 
 [tool.poetry.dependencies]
-python = "^3.10"
-numpy = "^2.2.0"
+python = ">=3.10,<4.0"
 scipy = "^1.14.1"
 h5py = "^3.12.1"
 matplotlib = "^3.9.3"
-seaborn = "^0.13.2"
 isort = "5.9.3"
+tabulate = "^0.9.0"
+numpy = "^2.2.3"
+lmfit = "^1.3.2"
 
 
 [tool.poetry.group.dev.dependencies]
@@ -27,6 +28,7 @@ mkdocs = "^1.6.1"
 mkdocs-material = "^9.5.48"
 mkdocstrings-python = "^1.12.2"
 pytest = "^8.3.4"
+mkdocs-jupyter = "^0.25.1"
 
 [build-system]
 requires = ["poetry-core"]
@@ -46,4 +48,4 @@ exclude = '''
 
 [tool.isort]
 profile = "black"
-known_first_party = ["sqil-core"]
+known_first_party = ["sqil-core"]

sqil_core-0.1.0/sqil_core/__init__.py

@@ -0,0 +1,6 @@
+import sqil_core.fit as fit
+import sqil_core.resonator as resonator
+import sqil_core.utils as utils
+from sqil_core.utils import *
+
+__all__ = utils.__all__ + ["utils", "fit", "resonator"]

sqil_core-0.1.0/sqil_core/config.py

@@ -0,0 +1,13 @@
+_EXCLUDED_PACKAGES = [
+    "os",
+    "sys",
+    "inspect",
+    "np",
+    "spopt",
+    "lmfit",
+    "h5py",
+    "json",
+    "tabulate",
+    "matplotlib",
+    "plt",
+]

sqil_core-0.1.0/sqil_core/fit/__init__.py

@@ -0,0 +1,16 @@
+from ._core import (
+    FitResult,
+    compute_adjusted_standard_errors,
+    compute_chi2,
+    fit_input,
+    fit_output,
+)
+from ._fit import (
+    fit_circle_algebraic,
+    fit_decaying_exp,
+    fit_decaying_oscillations,
+    fit_gaussian,
+    fit_lorentzian,
+    fit_qubit_relaxation_qp,
+    fit_skewed_lorentzian,
+)