aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorEugeniy E. Mikhailov <evgmik@gmail.com>2024-11-20 21:40:36 -0500
committerEugeniy E. Mikhailov <evgmik@gmail.com>2024-11-20 21:40:36 -0500
commit6555b3f055dd30bf38542a81fc4afff7af2832f4 (patch)
treeb6920118b8a22fcca29ea092a1bf7525d7084305
parentba1aa48aa9f0a5daab3619812733e67c4babf9db (diff)
downloadmatlab_strawberryfields-6555b3f055dd30bf38542a81fc4afff7af2832f4.tar.gz
matlab_strawberryfields-6555b3f055dd30bf38542a81fc4afff7af2832f4.zip
renamed and updated README
-rw-r--r--README.md21
-rw-r--r--Readme.md12
2 files changed, 21 insertions, 12 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ed44a8c
--- /dev/null
+++ b/README.md
@@ -0,0 +1,21 @@
+This is matlab implementation of some function
+from python package [Strawberry Fields](https://strawberryfields.ai/)
+
+They are handy for quantum optics mode calculations.
+
+Them most notable functions are
+- williamson: Williamson decomposition
+- bloch_messiah: Bloch Messiah decomposition
+- xpxp_to_xxpp: reordering covariance matrix
+- xxpp_to_xpxp: reordering covariance matrix
+
+There are also supporting functions:
+- takagi: Takagi decomposition
+- polardecomp: polar decomposition
+- sympmat: creates symplectic form matrix
+
+
+The initial conversion was done with Perplexity AI on 2024/11/19, but
+it required a human intervention for some of the code.
+
+
diff --git a/Readme.md b/Readme.md
deleted file mode 100644
index 65c1bee..0000000
--- a/Readme.md
+++ /dev/null
@@ -1,12 +0,0 @@
-This is matlab implementation of some function
-from python package [Strawberry Fields](https://strawberryfields.ai/)
-
-They are handy for quantum optics mode calculations.
-
-
-The initial conversion was done with Perplexity AI on 2024/11/19, but
-it required a human intervention for some of the code.
-Most notably xpxp_to_xxpp code was modified to match Matlab
-treatment of everything as at least two dimensional matrix.
-
-