Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add DMRG performer example and planted solutions information to benchmark readme. #60

Merged
merged 1 commit into from
Dec 10, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,15 @@ The paths to these files must be passed as arguments to the script, for example:
python compute_all_LREs_script.py -i ../problem_instances -o ../solution_files --LRE_config_file LRE_config.json --sftp_username darpa-qb --sftp_key_file path_to_ppk_file
```

### DMRG Performer Example

As a usage demonstration, we have `examples/run_dmrg.ipynb`. This notebook can be used to run density matrix renormalization group (DMRG) calculations on a choice of problem instance files and then produce solution files. Running instructions are included in the notebook.

### Planted Solutions

Several cropped complete active space (CCAS) planted solutions are already included in this benchmark. The related proctor json files, which include generation parameters, can be found in the [planted solutions repository](https://github.com/jtcantin/planted_solutions). The planted solutions repository includes code and instructions to generate more planted solutions.


<!-- ### Viewing Results
After running the benchmarks, generate a summary of performance:
```bash
Expand Down
Loading