Skip to content

Commit 38887a5

Browse files
tt in configure-qiskit-local (#1430)
There are some very small formatting issues in https://docs.quantum.ibm.com/start/configure-qiskit-local . Nothing terrible, it was just easy to fix than to report them. ![Screenshot 2024-05-27 at 13 51 06](https://github.com/Qiskit/documentation/assets/766693/d4363a4a-cc45-43bb-b165-c9a438fb0066) Co-authored-by: Eric Arellano <[email protected]>
1 parent 36eb999 commit 38887a5

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

docs/start/configure-qiskit-local.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ parallel = False
2424
num_processes = 15
2525
```
2626

27-
By default, this file is in `~/.qiskit/settings.conf` but the path can be overridden with the QISKIT_SETTINGS environment variable.
27+
By default, this file is in `~/.qiskit/settings.conf` but the path can be overridden with the `QISKIT_SETTINGS` environment variable.
2828

2929
## Available options
3030

@@ -33,8 +33,8 @@ By default, this file is in `~/.qiskit/settings.conf` but the path can be overri
3333
- `circuit_mpl_style_path`: The paths to have the circuit drawer use to look for JSON style sheets when using the mpl output mode.
3434
- `state_drawer`: This is used to change the default system for the state visualization draw methods. Valid values are `repr`, `text`, `latex`, `latex_source`, `qsphere`, `hinton`, or `bloch`. When the output kwarg is not explicitly set on the [qiskit.quantum_info.DensityMatrix.draw](../api/qiskit/qiskit.quantum_info.DensityMatrix#densitymatrix) method, the specified output method is used.
3535
- `transpile_optimization_level`: Change the default optimization level for [qiskit.compiler.transpile](../api/qiskit/compiler#circuit-and-pulse-compilation-functions). Specify an integer 0-3.
36-
- `parallel`: Whether Python multiprocessing is enabled for operations that support running in parallel. For example, transpilation of multiple [qiskit.circuit.QuantumCircuit](../api/qiskit/qiskit.circuit.QuantumCircuit#quantumcircuit-class) objects. This setting can be overridden by the QISKIT_PARALLEL environment variable. Specify a boolean value.
37-
- `num_processes`: The maximum number of parallel processes to launch for parallel operations if parallel execution is enabled. This setting can be overridden by the QISKIT_NUM_PROCS environment variable. Specify an integer greater than 0.
36+
- `parallel`: Whether Python multiprocessing is enabled for operations that support running in parallel. For example, transpilation of multiple [qiskit.circuit.QuantumCircuit](../api/qiskit/qiskit.circuit.QuantumCircuit#quantumcircuit-class) objects. This setting can be overridden by the `QISKIT_PARALLEL` environment variable. Specify a boolean value.
37+
- `num_processes`: The maximum number of parallel processes to launch for parallel operations if parallel execution is enabled. This setting can be overridden by the `QISKIT_NUM_PROCS` environment variable. Specify an integer greater than `0`.
3838

3939
<Admonition type="note">
4040
* Circuit drawer settings apply to [qiskit.circuit.QuantumCircuit.draw](../api/qiskit/qiskit.circuit.QuantumCircuit) and [qiskit.visualization.circuit_drawer.](../api/qiskit/qiskit.visualization.circuit_drawer#qiskitvisualizationcircuit_drawer)
@@ -45,10 +45,10 @@ By default, this file is in `~/.qiskit/settings.conf` but the path can be overri
4545

4646
Set these environment variables to alter the default behavior of Qiskit:
4747

48-
- QISKIT_PARALLEL: Enables Python multiprocessing to parallelize certain operations; for example, transpilation over multiple circuits in Qiskit. Specify a boolean value.
49-
- QISKIT_NUM_PROCS: The maximum number of parallel processes to launch for parallel operations if parallel execution is enabled. Specify an integer greater than zero.
50-
- RAYON_NUM_THREADS: The number of threads to run multithreaded operations in Qiskit. By default, multithreaded code launches a thread for each logical CPU. To adjust the number of threads Qiskit uses, set this to an integer value. For example, setting RAYON_NUM_THREADS=4 launches four threads for multithreaded functions.
51-
- QISKIT_FORCE_THREADS: Specifies that multithreaded code should always execute in multiple threads. By default, if you're running multithreaded code in a section of Qiskit that is already running in parallel processes, Qiskit does not launch multiple threads but instead executes that function serially. This is done to avoid potentially overloading limited CPU resources. However, if you want to force the use of multiple threads even when in a multiprocess context, set QISKIT_FORCE_THREADS=TRUE.
48+
- `QISKIT_PARALLEL`: Enables Python multiprocessing to parallelize certain operations; for example, transpilation over multiple circuits in Qiskit. Specify a boolean value.
49+
- `QISKIT_NUM_PROCS`: The maximum number of parallel processes to launch for parallel operations if parallel execution is enabled. Specify an integer greater than zero.
50+
- `RAYON_NUM_THREADS`: The number of threads to run multithreaded operations in Qiskit. By default, multithreaded code launches a thread for each logical CPU. To adjust the number of threads Qiskit uses, set this to an integer value. For example, setting RAYON_NUM_THREADS=4 launches four threads for multithreaded functions.
51+
- `QISKIT_FORCE_THREADS`: Specifies that multithreaded code should always execute in multiple threads. By default, if you're running multithreaded code in a section of Qiskit that is already running in parallel processes, Qiskit does not launch multiple threads but instead executes that function serially. This is done to avoid potentially overloading limited CPU resources. However, if you want to force the use of multiple threads even when in a multiprocess context, set `QISKIT_FORCE_THREADS=TRUE`.
5252

5353
## Next steps
5454

0 commit comments

Comments
 (0)