Skip to content

Commit bf1abbd

Browse files
authored
Merge pull request #17 from JoelPasvolsky/docsite_move
Update xrefs to docs for new URLs
2 parents cd021e4 + eb748da commit bf1abbd

1 file changed

Lines changed: 29 additions & 5 deletions

File tree

README.md

Lines changed: 29 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,28 @@ quantity to build, etc. In this example, we take a look at how we might
1414
formulate this optimization problem and solve it using D-Wave's binary
1515
quadratic model (BQM) hybrid solver.
1616

17+
## Installation
18+
19+
You can run this example without installation in cloud-based IDEs that support
20+
the [Development Containers specification](https://containers.dev/supporting)
21+
(aka "devcontainers").
22+
23+
For development environments that do not support ``devcontainers``, install
24+
requirements:
25+
26+
pip install -r requirements.txt
27+
28+
If you are cloning the repo to your local system, working in a
29+
[virtual environment](https://docs.python.org/3/library/venv.html) is
30+
recommended.
31+
1732
## Usage
1833

34+
Your development environment should be configured to
35+
[access Leap’s Solvers](https://docs.dwavequantum.com/en/latest/ocean/sapi_access_basic.html).
36+
You can see information about supported IDEs and authorizing access to your Leap
37+
account [here](https://docs.dwavequantum.com/en/latest/leap_sapi/dev_env.html).
38+
1939
To run the demo, type the command:
2040

2141
```python demo.py```
@@ -97,10 +117,11 @@ program will prefer locations that are far apart.
97117
### Build exactly two new charging stations
98118

99119
To select exactly two new charging stations, we use
100-
[`dimod.generators.combinations`](https://docs.ocean.dwavesys.com/en/stable/docs_dimod/reference/generated/dimod.generators.combinations.html?highlight=%22dimod.generators.combinations%22). This function in Ocean's `dimod` package
101-
sets exactly `num_new_cs` of our binary variables (`bqm.variables`) to have a
102-
value of 1, and applies a strength to this constraint (`gamma4`). See below for
103-
more information on the tunable strength parameter.
120+
[`dimod.generators.combinations`](https://docs.dwavequantum.com/en/latest/ocean/api_ref_dimod/generated/dimod.generators.combinations.html).
121+
This function in Ocean's `dimod` package sets exactly `num_new_cs` of our binary
122+
variables (`bqm.variables`) to have a value of 1, and applies a strength to this
123+
constraint (`gamma4`). See below for more information on the tunable strength
124+
parameter.
104125

105126
### Parameter tuning
106127

@@ -129,4 +150,7 @@ for-loops versus using efficient NumPy operations in the Leap IDE.
129150

130151
## References
131152

132-
<a name="1">[1]</a> Pagany, Raphaela, Anna Marquardt, and Roland Zink. "Electric Charging Demand Location Model—A User-and Destination-Based Locating Approach for Electric Vehicle Charging Stations." Sustainability 11.8 (2019): 2301. [https://doi.org/10.3390/su11082301](https://doi.org/10.3390/su11082301)
153+
<a name="1">[1]</a> Pagany, Raphaela, Anna Marquardt, and Roland Zink. "Electric
154+
Charging Demand Location Model—A User-and Destination-Based Locating Approach
155+
for Electric Vehicle Charging Stations." Sustainability 11.8 (2019): 2301.
156+
[https://doi.org/10.3390/su11082301](https://doi.org/10.3390/su11082301)

0 commit comments

Comments
 (0)