From d30c97ac533a727f085056d812f55800973d4107 Mon Sep 17 00:00:00 2001
From: jupfi <github@jupfi.me>
Date: Wed, 23 Aug 2023 20:08:44 +0200
Subject: [PATCH] Added LICENSE and README.md

---
 .gitignore                               |  3 ++-
 LICENSE                                  | 21 ++++++++++++++++
 README.md                                | 31 ++++++++++++++++++++++++
 pyproject.toml                           |  1 +
 src/nqr_blochsimulator/blochsimulator.py |  0
 5 files changed, 55 insertions(+), 1 deletion(-)
 delete mode 100644 src/nqr_blochsimulator/blochsimulator.py

diff --git a/.gitignore b/.gitignore
index 4ea05a1..24a2534 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,2 +1,3 @@
 venv/
-__pycache__/
\ No newline at end of file
+__pycache__/
+.vscode/
\ No newline at end of file
diff --git a/LICENSE b/LICENSE
index e69de29..3e4b8d3 100644
--- a/LICENSE
+++ b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Julia Pfitzer
+
+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.
\ No newline at end of file
diff --git a/README.md b/README.md
index e69de29..5caa0a9 100644
--- a/README.md
+++ b/README.md
@@ -0,0 +1,31 @@
+# NQR Bloch Simulator for Python
+
+This is a Python implementation of an NQR Bloch Simulator.
+
+Right now the implementation is in a early stage and has not yet been tested and verified.
+
+## Installation
+
+Create a virtual environment and activate it:
+
+```
+python -m venv venv
+source venv/bin/activate
+```
+
+To install the package, run the following command in the root directory of the project:
+
+```
+pip install .
+```
+
+The package can then be tested by running
+
+```
+python -m unittest tests/simulation.py
+```
+
+This will run a simulation of a simple FID for BiPh3 and plot the result in time domain.
+
+
+## References
\ No newline at end of file
diff --git a/pyproject.toml b/pyproject.toml
index 38e7109..4f2b721 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -27,4 +27,5 @@ dependencies = [
     "matplotlib",
     "numpy",
     "scipy",
+    "numpy",
 ]
\ No newline at end of file
diff --git a/src/nqr_blochsimulator/blochsimulator.py b/src/nqr_blochsimulator/blochsimulator.py
deleted file mode 100644
index e69de29..0000000