Skip to content

Commit 8cc7beb

Browse files
committed
Use "meta-package" phrasing
1 parent 332b568 commit 8cc7beb

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

profile/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ The [JuliaQuantumControl][] organization collects packages implementing a compre
55
[Quantum optimal control theory](https://link.springer.com/article/10.1140%2Fepjd%2Fe2015-60464-1) attempts to steer a quantum system in some desired way by finding optimal control parameters or control fields inside the system Hamiltonian or Liouvillian. Typical control tasks are the preparation of a specific quantum state or the realization of a logical gate in a quantum computer. Thus, quantum control theory is a critical part of realizing quantum technologies, at the lowest level. Numerical methods of *open-loop* quantum control (methods that do not involve measurement feedback from a physical quantum device) such as [Krotov's method][Krotov] and [GRAPE][] address the control problem by [simulating the dynamics of the system][QuantumPropagators] and then iteratively improving the value of a functional that encodes the desired outcome.
66

77

8-
The packages in [JuliaQuantumControl][] that implement specific individual methods are combined in a single high-level package [`QuantumControl.jl`][QuantumControl]. For normal usage, i.e., outside of development within the [JuliaQuantumControl][] organization, it should be sufficient to interact only with that [`QuantumControl.jl`][QuantumControl] package.
8+
The packages in [JuliaQuantumControl][] that implement specific individual methods are combined in a meta-package [`QuantumControl.jl`][QuantumControl]. For normal usage, i.e., outside of development within the [JuliaQuantumControl][] organization, it should be sufficient to interact only with the [`QuantumControl.jl`][QuantumControl] interface.
99

1010
## Packages
1111

@@ -15,7 +15,7 @@ The packages in [JuliaQuantumControl][] that implement specific individual metho
1515
|[QuantumControlBase.jl](https://github.com/JuliaQuantumControl/QuantumControlBase.jl) | [![Build Status](https://github.com/JuliaQuantumControl/QuantumControlBase.jl/workflows/CI/badge.svg)](https://github.com/JuliaQuantumControl/QuantumControlBase.jl/actions) | [![Coverage](https://codecov.io/gh/JuliaQuantumControl/QuantumControlBase.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaQuantumControl/QuantumControlBase.jl) | Shared methods and data structures for quantum control |
1616
|[Krotov.jl](https://github.com/JuliaQuantumControl/Krotov.jl) | [![Build Status](https://github.com/JuliaQuantumControl/Krotov.jl/workflows/CI/badge.svg)](https://github.com/JuliaQuantumControl/Krotov.jl/actions) | [![Coverage](https://codecov.io/gh/JuliaQuantumControl/Krotov.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaQuantumControl/Krotov.jl) | Krotov's method of optimal control |
1717
|[GRAPE.jl](https://github.com/JuliaQuantumControl/GRAPE.jl) | [![Build Status](https://github.com/JuliaQuantumControl/GRAPE.jl/workflows/CI/badge.svg)](https://github.com/JuliaQuantumControl/GRAPE.jl/actions) | [![Coverage](https://codecov.io/gh/JuliaQuantumControl/GRAPE.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaQuantumControl/GRAPE.jl) | Gradient Ascent Pulse Engineering method |
18-
|[QuantumControl.jl](https://github.com/JuliaQuantumControl/QuantumControl.jl) | [![Build Status](https://github.com/JuliaQuantumControl/QuantumControl.jl/workflows/CI/badge.svg)](https://github.com/JuliaQuantumControl/QuantumControl.jl/actions) | [![Coverage](https://codecov.io/gh/JuliaQuantumControl/QuantumControl.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaQuantumControl/QuantumControl.jl) | High-level API for quantum control, combining all packages |
18+
|[QuantumControl.jl](https://github.com/JuliaQuantumControl/QuantumControl.jl) | [![Build Status](https://github.com/JuliaQuantumControl/QuantumControl.jl/workflows/CI/badge.svg)](https://github.com/JuliaQuantumControl/QuantumControl.jl/actions) | [![Coverage](https://codecov.io/gh/JuliaQuantumControl/QuantumControl.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaQuantumControl/QuantumControl.jl) | Meta-package to combine all packages in a high-level API |
1919

2020

2121
## Documentation
@@ -25,7 +25,7 @@ Read the [`QuantumControl.jl` documentation](https://juliaquantumcontrol.github.
2525

2626
## Installation
2727

28-
The main [`QuantumControl.jl`][QuantumControl] package can be installed via the [standard Pkg manager](https://docs.julialang.org/en/v1/stdlib/Pkg/):
28+
The [`QuantumControl.jl`][QuantumControl] meta-package can be installed via the [standard Pkg manager](https://docs.julialang.org/en/v1/stdlib/Pkg/):
2929

3030
~~~
3131
pkg> add QuantumControl
@@ -37,7 +37,7 @@ This will also install all the packages of the [JuliaQuantumControl][] organizat
3737

3838
## Development
3939

40-
Development or pre-release use of [JuliaQuantumControl][] packages requires a [dev-installation](https://pkgdocs.julialang.org/v1/managing-packages/#developing) of *all* packages. To facilitate this, we provide a [development environment][JuliaQuantumControlDev] for the entire organization in the [`JuliaQuantumControl` repository][JuliaQuantumControlDev] . Cloning the repository provides a `Makefile` to develop across tall packages. In order to use this `Makefile`, it is strongly recommended that you use Unix as a development platform (Linux, macOS, or [WSL](https://docs.microsoft.com/en-us/windows/wsl/about) on Windows).
40+
Development or pre-release use of [JuliaQuantumControl][] packages requires a [dev-installation](https://pkgdocs.julialang.org/v1/managing-packages/#developing) of *all* packages. To facilitate this, we provide a [development environment][JuliaQuantumControlDev] for the entire organization in the [`JuliaQuantumControl` repository][JuliaQuantumControlDev] . Cloning the repository provides a `Makefile` to develop across all packages. In order to use this `Makefile`, it is strongly recommended that you use Unix as a development platform (Linux, macOS, or [WSL](https://docs.microsoft.com/en-us/windows/wsl/about) on Windows).
4141

4242
See [the repository's README](https://github.com/JuliaQuantumControl/JuliaQuantumControl#readme) for details.
4343

0 commit comments

Comments
 (0)