hzhangxyz commited on
Commit
2a09a7b
·
verified ·
1 Parent(s): 52742d7

Update README.md.

Browse files
Files changed (1) hide show
  1. README.md +25 -1
README.md CHANGED
@@ -1,3 +1,27 @@
 
 
 
 
 
 
 
1
  # QMB Models
2
 
3
- This repository contains several physical/chemical models.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ license: gpl-3.0
3
+ pretty_name: QMB Models
4
+ size_categories:
5
+ - 100M<n<1B
6
+ ---
7
+
8
  # QMB Models
9
 
10
+ This repository houses a collection of physical and chemical models.
11
+ These models are used as data for the `qmb` package, which can be found [here][qmb-url].
12
+
13
+ This repository contains data in OpenFermion format originally sourced from [here][naqs-url] and distributed under the MIT License.
14
+ To load the data in OpenFermion format, users can use the following Python code:
15
+ ```python
16
+ openfermion.MolecularData(filename="xxx.hdf5")
17
+ ```
18
+ For additional details, please consult the [official OpenFermion documentation][openfermion-url].
19
+
20
+ This repository also includes data in FCIDUMP format, which has been compressed using gzip to reduce file size.
21
+ FCIDUMP files typically contain essential information such as orbital number, electron number, and Hamiltonian data.
22
+ To facilitate ease of use for upstream applications, we have named the FCIDUMP files in a structured format: `{model}_{n_electrons}_{n_qubits}.FCIDUMP.gz`.
23
+ Additionally, we provide a reference energy catalog for these files in the file `FCIDUMP.json`.
24
+
25
+ [qmb-url]: https://github.com/USTC-KnowledgeComputingLab/qmb
26
+ [naqs-url]: https://github.com/tomdbar/naqs-for-quantum-chemistry
27
+ [openfermion-url]: https://quantumai.google/openfermion