Skip to content

Commit

Permalink
Merge pull request #60 from isi-usc-edu/jtcantin-readme_update_for_pl…
Browse files Browse the repository at this point in the history
…anted_solutions_

Add DMRG performer example and planted solutions information to benchmark readme.
  • Loading branch information
jtcantin authored Dec 10, 2024
2 parents 332e9a7 + 4d92600 commit 04de4d8
Showing 1 changed file with 9 additions and 0 deletions.
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

0 comments on commit 04de4d8

Please sign in to comment.