reformatted files

.pre-commit-config.yaml

@@ -0,0 +1,12 @@
+repos:
+  - repo: https://github.com/psf/black
+    rev: 24.10.0
+    hooks:
+      - id: black
+        language_version: python3
+
+  - repo: https://github.com/pre-commit/mirrors-isort
+    rev: v5.9.3
+    hooks:
+      - id: isort
+        language_version: python3

README.md

@@ -23,17 +23,26 @@ mag, phase, freq = sqil.extract_h5_data(path, ['mag_dB', 'phase', 'ro_freq'])
 
 ## Development
 
-Install poetry if you haven't already (`pip install poetry`) and then run the following
+1. Install poetry if you haven't already
+```bash
+$ pip install poetry
+```
 
+2. Install the required packages using poetry
 ```bash
 $ poetry install
+```
+
+3. Install the pre-commit hooks. This will automatically format your code before committing
+```bash
 $ poetry run pre-commit install
 ```
 
-Start the virtual environment
+4. Start the virtual environment
 ```bash
 $ poetry shell
 ```
+
 To exit the virtual environment just use `exit`
 
 #### Test your changes
@@ -44,13 +53,17 @@ $ pip install -e . --user
 
 **Anaconda**
 If you want to install in a specific anaconda environment
+
 - from your poetry shell build the package
+
 ```bash
 $ poetry run build
 ```
+
 - open an anaconda shell
 - activate the desired environemnt
 - pip install the wheel file (.whl) in the dist folder of the sqil-core project
+
 ```bash
 $ pip install PATH_TO_SQIL_CORE_FOLDER/dist/SQIL_CORE-VERSION.whl
 ```

pyproject.toml

@@ -17,11 +17,11 @@ scipy = "^1.14.1"
 h5py = "^3.12.1"
 matplotlib = "^3.9.3"
 seaborn = "^0.13.2"
+isort = "5.9.3"
 
 
 [tool.poetry.group.dev.dependencies]
 black = "^24.10.0"
-isort = "^5.13.2"
 pre-commit = "^4.0.1"
 mkdocs = "^1.6.1"
 mkdocs-material = "^9.5.48"