mirror of
https://github.com/nqrduck/nqr-blochsimulator.git
synced 2024-06-15 18:35:17 +00:00
Added LICENSE and README.md
This commit is contained in:
parent
6a7e154e26
commit
d30c97ac53
3
.gitignore
vendored
3
.gitignore
vendored
|
@ -1,2 +1,3 @@
|
||||||
venv/
|
venv/
|
||||||
__pycache__/
|
__pycache__/
|
||||||
|
.vscode/
|
21
LICENSE
21
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.
|
31
README.md
31
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
|
|
@ -27,4 +27,5 @@ dependencies = [
|
||||||
"matplotlib",
|
"matplotlib",
|
||||||
"numpy",
|
"numpy",
|
||||||
"scipy",
|
"scipy",
|
||||||
|
"numpy",
|
||||||
]
|
]
|
Loading…
Reference in a new issue