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

Unify system and Ocean content #324

Merged
merged 109 commits into from
Mar 26, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
109 commits
Select commit Hold shift + click to select a range
4f52ce7
Initial inclusion of system docs
JoelPasvolsky Sep 17, 2024
7711064
Add ocean docs to system docs overall structure
JoelPasvolsky Sep 18, 2024
43ffbfb
Restructure ocean for combined docset
JoelPasvolsky Oct 1, 2024
e407d11
Draft the restructure of Ocean's intro
JoelPasvolsky Oct 3, 2024
340d920
Restructure hybrid examples
JoelPasvolsky Oct 3, 2024
76895e6
Restructure QPU examples
JoelPasvolsky Oct 3, 2024
d536665
Rescale logo by 70%
JoelPasvolsky Oct 3, 2024
aec24eb
Update license & contribute, GM intro
JoelPasvolsky Oct 4, 2024
8959bc1
Restructure what & where section
JoelPasvolsky Oct 7, 2024
783c9bc
Set two topics in index tabs, hide license & contribute, update footer
JoelPasvolsky Oct 10, 2024
466eb39
Add from packages (part one of dimod)
JoelPasvolsky Oct 10, 2024
af85989
Reunite glossary and fundamentals
JoelPasvolsky Oct 10, 2024
1716ac2
Cleanup index filenames, glossary restructure, docs navigation
JoelPasvolsky Oct 15, 2024
fe80272
Add from packages: dimod part 2/2
JoelPasvolsky Oct 16, 2024
fcfa81f
Implement stakeholder feedback
JoelPasvolsky Oct 29, 2024
25e4637
Add some hybrid content
JoelPasvolsky Oct 29, 2024
8091fd0
Add remaining ocean intro content
JoelPasvolsky Oct 30, 2024
166c886
Rationalize quantum research indices
JoelPasvolsky Oct 31, 2024
6061bf4
Add stub refs for quantum research
JoelPasvolsky Nov 4, 2024
39d77ad
Add stub refs for optimization, shared examples
JoelPasvolsky Nov 4, 2024
7ddf495
order ocean sections
JoelPasvolsky Nov 5, 2024
ad2a3f5
Format index sections for industrial optimization
JoelPasvolsky Nov 5, 2024
9547a14
Format index sections for quantum research
JoelPasvolsky Nov 6, 2024
dfc2c60
Rationalize file names
JoelPasvolsky Nov 7, 2024
78e644c
Slightly refine section structure
JoelPasvolsky Nov 7, 2024
88d7896
Consolidate hybrid solver properties & params
JoelPasvolsky Nov 8, 2024
d653e49
Add content for solver properties & parameters
JoelPasvolsky Dec 4, 2024
47b37f6
Update entries of Concepts page
JoelPasvolsky Dec 5, 2024
dbfe2b4
Add content from sys doc's Getting Started
JoelPasvolsky Dec 6, 2024
4e867a6
Add bibliography and admin stubs, turn on numfig, remove pyqubo
JoelPasvolsky Jan 17, 2025
20ff389
Initial check-in of admin guide.
qwriter Jan 17, 2025
2648bdf
Add sys-doc images and pre-path-updated content
JoelPasvolsky Jan 22, 2025
2564e44
Add shared content from system docs
JoelPasvolsky Jan 28, 2025
8b0900d
Add SAPI REST and penaltymodel intro
JoelPasvolsky Jan 29, 2025
1f7c438
Add icons to Optimization and Quantum
k8culver Feb 11, 2025
8526d51
Make grid-item-card clickable
k8culver Feb 11, 2025
3285753
Add CSS styling
k8culver Feb 13, 2025
afe96c2
Add release notes & code
JoelPasvolsky Jan 31, 2025
0b2e9f2
Updating graphic paths: getting started, problem-solving, and solver …
JoelPasvolsky Feb 4, 2025
1c658ff
Updating graphic paths: remaining sys doc content
JoelPasvolsky Feb 4, 2025
9d5e8f9
Fix all missing remaining graphics
JoelPasvolsky Feb 4, 2025
5bc250a
Fix todos
JoelPasvolsky Feb 5, 2025
7dd78ce
Update xrefs: part 1 (of many parts)
JoelPasvolsky Feb 5, 2025
9570b65
Update xrefs: part 2
JoelPasvolsky Feb 6, 2025
b8548c4
Update xrefs: part 3
JoelPasvolsky Feb 7, 2025
d96cd5d
Update xrefs: part 4
JoelPasvolsky Feb 7, 2025
e59c18d
Update xrefs: part 5
JoelPasvolsky Feb 10, 2025
565933b
Update xrefs: part 6
JoelPasvolsky Feb 11, 2025
2d7db0a
Update xrefs: part 7 and single source examples requirements & steps
JoelPasvolsky Feb 12, 2025
fcbc007
Update end-to-end examples: part 1
JoelPasvolsky Feb 12, 2025
761ba34
Add Leap and Ocean icons
k8culver Feb 18, 2025
78f454d
Update end-to-end examples: part 2
JoelPasvolsky Feb 13, 2025
f05026f
Update end-to-end examples: part 3
JoelPasvolsky Feb 13, 2025
76d3c95
Update end-to-end examples: part 4
JoelPasvolsky Feb 14, 2025
5cd6f20
Restructure QPU beginner examples
JoelPasvolsky Feb 18, 2025
41e6c1a
Restructure optimization examples
JoelPasvolsky Feb 18, 2025
bec63df
Update end-to-end examples: part 5
JoelPasvolsky Feb 18, 2025
376fbcd
Update xrefs: part 8 and single-source workflow
JoelPasvolsky Feb 20, 2025
5df3453
Update xrefs: part 9 (content under ocean)
JoelPasvolsky Feb 21, 2025
82389f7
Update xrefs: part 10 (inc search on :std:doc:)
JoelPasvolsky Feb 21, 2025
35fb627
Fix some warnings and add scaling JN
JoelPasvolsky Feb 21, 2025
7874c07
Wrap up some concepts formatting
JoelPasvolsky Feb 25, 2025
7f0973f
PLACEHOLDER packages update: part 1
JoelPasvolsky Feb 26, 2025
50498f1
Flatten licenses structure (can next remove from <package>/docs)
JoelPasvolsky Feb 26, 2025
60a08d6
PLACEHOLDER packages update: part 1b
JoelPasvolsky Feb 27, 2025
5d1a8b0
Rename softlinks to package docs directories
JoelPasvolsky Feb 27, 2025
a1aaec2
Rename a couple of intro files
JoelPasvolsky Feb 27, 2025
8fc66b1
PLACEHOLDER packages update: part 2
JoelPasvolsky Feb 28, 2025
3a5630e
PLACEHOLDER packages update: part 3 (plus error/warning fixes)
JoelPasvolsky Feb 28, 2025
d9ad59f
Remove 1200 silly warnings
JoelPasvolsky Mar 1, 2025
b2973ce
Restructure some files (embedding, hybrid names)
JoelPasvolsky Mar 3, 2025
6c86b2c
Add some signposts
JoelPasvolsky Mar 3, 2025
10c6f65
Add physical properties and anneal schedules for QPUs.
qwriter Mar 3, 2025
58aea96
Remove ref folders in repos and some updates in per-qpu properties
JoelPasvolsky Mar 3, 2025
4825a31
PLACEHOLDER packages update: part 4
JoelPasvolsky Mar 4, 2025
b873d72
Fix SDK build warnings from repos
JoelPasvolsky Mar 4, 2025
06411b7
Fix SDK build warnings from SDK repo
JoelPasvolsky Mar 4, 2025
fdfc659
Fix conf.py error
JoelPasvolsky Mar 4, 2025
5f9297b
Fix remaining build warnings from former system docs
JoelPasvolsky Mar 4, 2025
0ef2f70
Fix warnings on duplicate substitutions
JoelPasvolsky Mar 6, 2025
8aa3df5
Fix math macros and clean some remaining files
JoelPasvolsky Mar 10, 2025
969792a
Fix failed doctests and simple todo items
JoelPasvolsky Mar 11, 2025
0ebc9cb
Fix most doctest errors (still need to fix dwave-gate circuit error)
JoelPasvolsky Mar 12, 2025
bf35c69
Quick fix dwave-gate for last doctest failures
JoelPasvolsky Mar 12, 2025
c32b222
Fix config.yml for JN, rename Using Hybrid Solvers, move NL example
JoelPasvolsky Mar 13, 2025
e0a56c5
Add notebook for testing scaling JN to requirements
JoelPasvolsky Mar 13, 2025
4b8d3d8
Hover on :term: to distinguish from references
JoelPasvolsky Mar 14, 2025
3033d9e
Hover on :term: 2: fix capitalization in glossary and enable mathjax
JoelPasvolsky Mar 14, 2025
c692266
Rename top-level `index` files for URL shortcuts, move contribute, ad…
JoelPasvolsky Mar 14, 2025
355f28d
Add .readthedocs.yaml (for new RTD projects)
JoelPasvolsky Mar 14, 2025
3a921a4
Add CC to license for documentation
JoelPasvolsky Mar 14, 2025
ba3079f
Rename files to remove directory prefixes
JoelPasvolsky Mar 17, 2025
0168f86
Update name in license, bibliography, inverse rocket icon
JoelPasvolsky Mar 17, 2025
c83a76a
Add pyqir requirement and update some packages
JoelPasvolsky Mar 18, 2025
aa4bbd0
Update for 6 repos restructuring merged
JoelPasvolsky Mar 18, 2025
68a5832
Update some straggling links, lower dropdown panel for new users, fix…
JoelPasvolsky Mar 19, 2025
fea39b7
Update for 5 updated modules
JoelPasvolsky Mar 20, 2025
de211ac
Add ML tab
JoelPasvolsky Mar 20, 2025
884048b
Update for all updated packages except dwave-system
JoelPasvolsky Mar 20, 2025
1e83d04
Add ocean version (SDK page and footer)
JoelPasvolsky Mar 20, 2025
fdae03a
Update for dwave-system package plus some editing
JoelPasvolsky Mar 21, 2025
d008535
Edits and minor doc fixes
JoelPasvolsky Mar 21, 2025
30231ad
Small edits for the optimization sections
JoelPasvolsky Mar 24, 2025
7ac534c
Test Devan's proposal for RNs by linking
JoelPasvolsky Mar 24, 2025
1a4ba45
Add a nav-bar link to Leap RNs (missed from previous commit)
JoelPasvolsky Mar 24, 2025
b8f3cc2
Small edits
JoelPasvolsky Mar 24, 2025
5327e4f
added some content, edits, and fixes for broken xrefs & todos
JoelPasvolsky Mar 25, 2025
bd15813
Remove `.gti` suffixes in `.gitmodule` and Python path from jupyter t…
JoelPasvolsky Mar 25, 2025
d73e721
Update for reviewer comments (@randomir & @thisac) and plugin
JoelPasvolsky Mar 26, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
8 changes: 7 additions & 1 deletion .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ jobs:
command: |
. env/bin/activate
apt update && apt install -yq doxygen graphviz
make -C docs/ html
make -C docs/ html

- store_artifacts:
path: ./docs/_build/html
Expand All @@ -187,6 +187,12 @@ jobs:
command: |
. env/bin/activate
make -C docs/ linkcheck || true
- run:
# If we add more notebooks in the future we can make this more general.
name: test scaling guide
command: |
. env/bin/activate
jupyter nbconvert --to notebook --execute docs/downloadables/scaling_for_production.ipynb

deploy:
docker:
Expand Down
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,9 @@ local_settings.py
instance/
.webassets-cache

# Mac OS
*.DS_Store

# Scrapy stuff:
.scrapy

Expand Down
66 changes: 33 additions & 33 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -1,39 +1,39 @@
[submodule "dwave-system"]
path = dwave-system
url = https://github.com/dwavesystems/dwave-system
[submodule "dwave-networkx"]
path = dwave-networkx
url = https://github.com/dwavesystems/dwave_networkx
[submodule "dwave-hybrid"]
path = dwave-hybrid
url = https://github.com/dwavesystems/dwave-hybrid
[submodule "dimod"]
path = dimod
url = https://github.com/dwavesystems/dimod
path = dimod
url = https://github.com/dwavesystems/dimod
[submodule "dwavebinarycsp"]
path = dwavebinarycsp
url = https://github.com/dwavesystems/dwavebinarycsp
path = dwavebinarycsp
url = https://github.com/dwavesystems/dwavebinarycsp
[submodule "dwave-cloud-client"]
path = dwave-cloud-client
url = https://github.com/dwavesystems/dwave-cloud-client
[submodule "minorminer"]
path = minorminer
url = https://github.com/dwavesystems/minorminer
[submodule "penaltymodel"]
path = penaltymodel
url = https://github.com/dwavesystems/penaltymodel
path = dwave-cloud-client
url = https://github.com/dwavesystems/dwave-cloud-client
[submodule "dwave-gate"]
path = dwave-gate
url = https://github.com/dwavesystems/dwave-gate
[submodule "dwave-hybrid"]
path = dwave-hybrid
url = https://github.com/dwavesystems/dwave-hybrid
[submodule "dwave-inspector"]
path = dwave-inspector
url = https://github.com/dwavesystems/dwave-inspector.git
path = dwave-inspector
url = https://github.com/dwavesystems/dwave-inspector
[submodule "dwave-networkx"]
path = dwave-networkx
url = https://github.com/dwavesystems/dwave_networkx
[submodule "dwave-optimization"]
path = dwave-optimization
url = https://github.com/dwavesystems/dwave-optimization
[submodule "dwave-preprocessing"]
path = dwave-preprocessing
url = https://github.com/dwavesystems/dwave-preprocessing.git
path = dwave-preprocessing
url = https://github.com/dwavesystems/dwave-preprocessing
[submodule "dwave-samplers"]
path = dwave-samplers
url = https://github.com/dwavesystems/dwave-samplers.git
[submodule "dwave-gate"]
path = dwave-gate
url = https://github.com/dwavesystems/dwave-gate.git
[submodule "dwave-optimization"]
path = dwave-optimization
url = https://github.com/dwavesystems/dwave-optimization.git
path = dwave-samplers
url = https://github.com/dwavesystems/dwave-samplers
[submodule "dwave-system"]
path = dwave-system
url = https://github.com/dwavesystems/dwave-system
[submodule "minorminer"]
path = minorminer
url = https://github.com/dwavesystems/minorminer
[submodule "penaltymodel"]
path = penaltymodel
url = https://github.com/dwavesystems/penaltymodel
23 changes: 23 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
version: 2

submodules:
include: all

sphinx:
builder: html
configuration: docs/conf.py

python:
install:
- method: pip
path: .
extra_requirements: [all]
- requirements: docs/requirements.txt

build:
os: ubuntu-22.04
tools:
python: "3.10"
jobs:
post_checkout:
- git fetch --unshallow || true
Binary file added docs/_images/01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/16q-pause.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/16q-quench.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/2q_chi_diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/2q_misbalancing_diagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/4states.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/_images/ChimeraUnitCell.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/Chimera_2x2_unit_cells.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/Chimera_qubits_2x2_internals.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/Chimera_qubits_3x3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/HybridBlockDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/Pegasus_internal_coupled.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/Pegasus_odd_coupled.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/Pegasus_qubits.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/Problem_CFD_HTML_Circuit_Outputs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/QPU_access_time.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/Techniques_LinearEquality_MIS.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/adj-reference.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/admin_meatball_menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/advantage_system.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/_images/alg1.png
Binary file added docs/_images/alg2.png
Binary file added docs/_images/ancilla-qubit-delta-tuning.png
Binary file added docs/_images/and_truth_table_colored.png
Binary file added docs/_images/annealing-functions.png
Binary file added docs/_images/annealing-schedule-adv2-proto2.png
Binary file added docs/_images/annealing-schedule-adv4.png
Binary file added docs/_images/annealing-schedule-adv5.png
Binary file added docs/_images/annealing-schedule-adv6.png
Binary file added docs/_images/annealing-schedule-adv7.png
Binary file added docs/_images/annealing_trajectories.png
Binary file added docs/_images/best_worst_routes.png
1 change: 1 addition & 0 deletions docs/_images/bipartite_icon.svg
Binary file added docs/_images/bipartite_new.png
Binary file added docs/_images/chainstrength_ssn30_embedding.png
Binary file added docs/_images/chainstrength_ssn30_histogram_1.png
Binary file added docs/_images/chi_vs_s.png
1 change: 1 addition & 0 deletions docs/_images/cli_icon.svg
Binary file added docs/_images/composing_samplers.png
Binary file added docs/_images/conven.png
Binary file added docs/_images/coupler-quantization-error-adv4.png
Binary file added docs/_images/coupler-quantization-error-adv5.png
Binary file added docs/_images/coupler-quantization-error-adv6.png
Binary file added docs/_images/decomposing_energy_impact.png
1 change: 1 addition & 0 deletions docs/_images/development_icon.svg
1 change: 1 addition & 0 deletions docs/_images/documentation_icon.svg
Binary file added docs/_images/dual_conflict_graph.png
Binary file added docs/_images/dw2x_solutions.png
Binary file added docs/_images/dw2x_solutions_fpr.png
Binary file added docs/_images/dwave.png
Binary file added docs/_images/eid_bfs_pfs.png
Binary file added docs/_images/eid_energy.png
Binary file added docs/_images/eigenspectrum.png
Binary file added docs/_images/embedding.png
Binary file added docs/_images/embedding_5vars_6qubits.png
Binary file added docs/_images/embedding_k5_pegasus.png
Binary file added docs/_images/embedding_sparse_bqm.png
Binary file added docs/_images/embedding_sparse_bqm_clique.png
Binary file added docs/_images/embedding_sparse_bqm_not_clique.png
Binary file added docs/_images/embedding_three_gates.png
Binary file added docs/_images/embedding_three_k5s_global.png
Binary file added docs/_images/embedding_three_k5s_local.png
Binary file added docs/_images/energy_gap.png
Binary file added docs/_images/entropy_solutions.png
Binary file added docs/_images/example_64q_noise_spectrum.png
Binary file added docs/_images/extendedJ.png
Binary file added docs/_images/fast_anneal_schedule.png
Binary file added docs/_images/flux_bias_offset.png
Binary file added docs/_images/flux_bias_offset_h_vs_fb.png
Binary file added docs/_images/flux_bias_offset_h_vs_j.png
Binary file added docs/_images/format_test_pin.png
Binary file added docs/_images/four_node_star_graph.png
Binary file added docs/_images/gaussian_systematic_h.png
Binary file added docs/_images/gaussian_systematic_j.png
Binary file added docs/_images/hamiltonian-distortion-single-q.png
Binary file added docs/_images/hamiltonian-distortion-two-q.png
1 change: 1 addition & 0 deletions docs/_images/hardware_icon.svg
Binary file added docs/_images/highlevel_timing.png
Binary file added docs/_images/hss_bqm_v1_vs_v2_from_pdf.png
1 change: 1 addition & 0 deletions docs/_images/hybrid_icon.svg
1 change: 1 addition & 0 deletions docs/_images/ide_icon.svg
Binary file added docs/_images/ip-comp-quantization-error-adv4.png
Binary file added docs/_images/ip-comp-quantization-error-adv5.png
Binary file added docs/_images/ip-comp-quantization-error-adv7.png
Binary file added docs/_images/ip-vs-logical-qubit-size.png
Binary file added docs/_images/ip_vs_delta.png
Binary file added docs/_images/kl_solutions_prime.png
Binary file added docs/_images/knapsack_simple_matrix.png
Binary file added docs/_images/leap_admin_dashboard_login.png
Binary file added docs/_images/leap_admin_dwave_main_page.png
Binary file added docs/_images/leap_admin_filter_col.png
Binary file added docs/_images/leap_admin_filter_combo.png
Binary file added docs/_images/leap_admin_filter_single.png
Binary file added docs/_images/leap_admin_gear_col.png
Binary file added docs/_images/leap_admin_global_search.png
Loading