-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
20 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,38 @@ | ||
# OpTion | ||
|
||
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/wittscien/OpTion/blob/main/LICENSE) | ||
![compatibility](https://img.shields.io/badge/Mathematica-10.x_11.x_12.x_13.x-blue.svg) | ||
|
||
[OpTion](https://github.com/wittscien/OpTion) (Operator construcTion) is a Mathematica package for operator construction in lattice QCD. | ||
|
||
# Installation | ||
|
||
There is a Test.nb file under the repository Tests and can run directly. To install the package, | ||
There is a Test.nb file under the repository Tests and it can run directly. To install the package, | ||
|
||
* Download the source zip file from GitHub. | ||
|
||
* Clone the zip file from GitHub. | ||
* Extract the zip file and move the repository to the Applications directory inside (or directly clone at) | ||
|
||
* Extract the zip file and move the repository to the Applications directory inside FileNameJoin[{$UserBaseDirectory, "Applications"}]. | ||
``` | ||
FileNameJoin[{$UserBaseDirectory, "Applications"}] | ||
``` | ||
|
||
To load the package, run | ||
To load the package, simply run | ||
|
||
``` | ||
<<OpTion` | ||
``` | ||
|
||
# Documentation | ||
|
||
Please see Manual/OpTion_manual.pdf in the repository. | ||
Please see [Manual/OpTion_manual.pdf](https://github.com/wittscien/OpTion/blob/main/Manual/OpTion_manual.pdf) in the repository. | ||
|
||
# Acknowledging OpTion | ||
|
||
The construction method is described in | ||
Please acknowledge our work when you use OpTion in your research by citing the following paper where the construction method is described: | ||
|
||
* Haobo Yan *et al*, in preparation, [arXiv:2408.xxxx](https://arxiv.org/abs/2408.xxxx). | ||
|
||
# Contact | ||
|
||
* Haobo Yan, in preparation, [arXiv:2408.xxxx](https://arxiv.org/abs/2408.xxxx) | ||
For questions or comments, please contact [Haobo Yan]([email protected]) or find him in person at either the office or more likely, a badminton court. |