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

Update links to repo and documentation #227

Merged
merged 4 commits into from
Jun 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion CITATION.bib
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@ @misc{qiskit_dynamics_2021
year = {2021},
publisher = {GitHub},
journal = {GitHub repository},
url = {https://github.com/Qiskit/qiskit-dynamics}
url = {https://github.com/Qiskit-Extensions/qiskit-dynamics}
}
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,7 @@ as:
fixes:
- |
Fixes a race condition in the function ``foo()``. Refer to
`#12345 <https://github.com/Qiskit/qiskit-dynamics/issues/12345>` for more
`#12345 <https://github.com/Qiskit-Extensions/qiskit-dynamics/issues/12345>` for more
details.
```

Expand Down
67 changes: 32 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,26 +4,26 @@

**This repo is still in the early stages of development, there will be breaking API changes**

Qiskit Dynamics is an open-source project for building, transforming, and solving
time-dependent quantum systems in Qiskit.

The goal of Qiskit Dynamics is to provide access to different numerical
methods for solving differential equations, and to automate common processes typically performed by hand,
e.g. applying frame transformations or rotating wave approximations to system and control Hamiltonians.

Qiskit Dynamics can be configured to use either
[NumPy](https://github.com/numpy/numpy) or [JAX](https://github.com/google/jax)
as the backend for array operations. [NumPy](https://github.com/numpy/numpy) is the default,
and [JAX](https://github.com/google/jax) is an optional dependency.
[JAX](https://github.com/google/jax) provides just-in-time compilation, automatic differentiation,
and GPU execution, and therefore is well-suited to tasks involving repeated
evaluation of functions with different parameters; E.g. simulating a model of a quantum system
over a range of parameter values, or optimizing the parameters of control sequence.

Reference documentation may be found [here](https://qiskit.org/documentation/dynamics/),
including [tutorials](https://qiskit.org/documentation/dynamics/tutorials),
[user guide](https://qiskit.org/documentation/dynamics/userguide),
and [API reference](https://qiskit.org/documentation/dynamics/apidocs).
Qiskit Dynamics is an open-source project for building, transforming, and solving time-dependent
quantum systems in Qiskit.

The goal of Qiskit Dynamics is to provide access to different numerical methods for solving
differential equations, and to automate common processes typically performed by hand, e.g. applying
frame transformations or rotating wave approximations to system and control Hamiltonians.

Qiskit Dynamics can be configured to use either [NumPy](https://github.com/numpy/numpy) or
[JAX](https://github.com/google/jax) as the backend for array operations.
[NumPy](https://github.com/numpy/numpy) is the default, and [JAX](https://github.com/google/jax) is
an optional dependency. [JAX](https://github.com/google/jax) provides just-in-time compilation,
automatic differentiation, and GPU execution, and therefore is well-suited to tasks involving
repeated evaluation of functions with different parameters; E.g. simulating a model of a quantum
system over a range of parameter values, or optimizing the parameters of control sequence.

Reference documentation may be found [here](https://qiskit.org/ecosystem/dynamics/), including
[tutorials](https://qiskit.org/ecosystem/dynamics/tutorials/index.html),
[user guide](https://qiskit.org/ecosystem/dynamics/userguide/index.html),
[API reference](https://qiskit.org/ecosystem/dynamics/apidocs/index.html), and
[Discussions](https://qiskit.org/ecosystem/dynamics/discussions/index.html).

## Installation

Expand All @@ -46,25 +46,22 @@ Installing JAX with GPU support must be done manually, for instructions refer to

## Contribution Guidelines

If you'd like to contribute to Qiskit Dynamics, please take a look at our
[contribution guidelines](CONTRIBUTING.md). This project adheres to Qiskit's
[code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to
uphold this code.

We use [GitHub issues](https://github.com/Qiskit/qiskit-dynamics/issues) for
tracking requests and bugs. Please
[join the Qiskit Slack community](https://qisk.it/join-slack)
and use our [#qiskit-dynamics](https://qiskit.slack.com/archives/C03E7UVCDEV) channel for discussion and
simple questions.
For questions that are more suited for a forum we use the Qiskit tag in the
If you'd like to contribute to Qiskit Dynamics, please take a look at our
[contribution guidelines](CONTRIBUTING.md). This project adheres to Qiskit's
[code of conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code.

We use [GitHub issues](https://github.com/Qiskit-Extensions/qiskit-dynamics/issues) for tracking
requests and bugs. Please [join the Qiskit Slack community](https://qisk.it/join-slack) and use our
[#qiskit-dynamics](https://qiskit.slack.com/archives/C03E7UVCDEV) channel for discussion and simple
questions. For questions that are more suited for a forum we use the Qiskit tag in the
[Stack Exchange](https://quantumcomputing.stackexchange.com/questions/tagged/qiskit).

## Authors and Citation

Qiskit Dynamics is the work of
[many people](https://github.com/Qiskit/qiskit-dynamics/graphs/contributors) who contribute
to the project at different levels. If you use Qiskit, please cite as per the included
[BibTeX file](https://github.com/Qiskit/qiskit-dynamics/blob/main/CITATION.bib).
Qiskit Dynamics is the work of
[many people](https://github.com/Qiskit-Extensions/qiskit-dynamics/graphs/contributors) who
contribute to the project at different levels. If you use Qiskit, please cite as per the included
[BibTeX file](https://github.com/Qiskit-Extensions/qiskit-dynamics/blob/main/CITATION.bib).

## License

Expand Down
2 changes: 1 addition & 1 deletion docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ just-in-time compilation, automatic differentiation, and GPU execution of Qiskit
This package is still in the early stages of development and it is very likely
that there will be breaking API changes in future releases.
If you encounter any bugs please open an issue on
`Github <https://github.com/Qiskit/qiskit-dynamics/issues>`_
`Github <https://github.com/Qiskit-Extensions/qiskit-dynamics/issues>`_


.. toctree::
Expand Down
9 changes: 9 additions & 0 deletions releasenotes/notes/move-repo-c0b48ba3b0ced8db.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
---
other:
- |
The repository has been moved from
[github.com/Qiskit/qiskit-dynamics](https://github.com/Qiskit/qiskit-dynamics) to
[github.com/Qiskit-Extensions/qiskit-dynamics](https://github.com/Qiskit-Extensions/qiskit-dynamics),
and the documentation has been moved from
[qiskit.org/documentation/dynamics](https://qiskit.org/documentation/dynamics) to
[qiskit.org/ecosystem/dynamics](https://qiskit.org/ecosystem/dynamics/).
8 changes: 4 additions & 4 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
description="Qiskit ODE solver",
long_description=README,
long_description_content_type='text/markdown',
url="https://github.com/Qiskit/qiskit-dynamics",
url="https://github.com/Qiskit-Extensions/qiskit-dynamics",
author="Qiskit Development Team",
author_email="[email protected]",
license="Apache 2.0",
Expand All @@ -68,9 +68,9 @@
],
keywords="qiskit sdk quantum",
project_urls={
"Bug Tracker": "https://github.com/Qiskit/qiskit-dynamics/issues",
"Source Code": "https://github.com/Qiskit/qiskit-dynamics",
"Documentation": "https://qiskit.org/documentation/dynamics",
"Bug Tracker": "https://github.com/Qiskit-Extensions/qiskit-dynamics/issues",
"Source Code": "https://github.com/Qiskit-Extensions/qiskit-dynamics",
"Documentation": "https://qiskit.org/ecosystem/dynamics/",
},
install_requires=requirements,
include_package_data=True,
Expand Down