0.39 release (#2457)

* start 0.39 release notes * release highlights * use different link for qrack readme * ignore anchors for qrack readme link works, but linkcheck is failing * clarify qrack use in tutorial * ignore changelog URLs; fixes #2438
unitaryfund · Aug 7, 2024 · febde1b · febde1b
1 parent 56ee173
commit febde1b
Show file tree

Hide file tree

Showing 4 changed files with 32 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,7 +1,31 @@
 # Changelog
 
 ## Version 0.39.0
-_In development_
+
+([Full Changelog](https://github.com/unitaryfund/mitiq/compare/v0.38.0...v0.39.0))
+
+### Highlights
+
+We've made updates to our documentation, beginning with the completion of the first section of the Pauli Twirling user guide, which offers a comprehensive introduction to this feature.
+Additionally, we've added a new tutorial on CDR (Clifford Data Regression) using [Qrack](https://github.com/unitaryfund/qrack/) as an efficient near-Clifford simulator.
+This demonstrates a workflow that harnesses the speed of Qrack in the CDR training phase, while providing users with an in-depth look at how to integrate Mitiq and Qrack effectively.
+
+#### 📓 Documentation
+
+- Complete first section of Pauli Twirling user guide (#2454) [@cosenal]
+- Hide primary sidebar from certain pages of the documentation (#2424) [@purva-thakre]
+- CDR Tutorial with Qrack (#2451) [@bdg221]
+
+#### 🧑🏽‍💻 Developer Improvements
+
+- Separate docs build workflow (#2441) [@purva-thakre]
+- clean and git ignore all coverage reports (#2443) [@cosenal]
+- Ignore _about.py in pytest coverage (#2379) [@purva-thakre]
+- use date to make version unique for testpypi uploads (#2436) [@natestemen]
+
+#### 📦 Dependency Updates
+
+- Update scipy requirement from <=1.13.1,>=1.10.1 to >=1.10.1,<=1.14.0 (#2420) [@dependabot]
 
 ## Version 0.38.0 
 

diff --git a/VERSION.txt b/VERSION.txt
@@ -1 +1 @@
-0.39.0dev
+0.39.0
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -199,10 +199,15 @@ def setup(app):
     r"https://doi\.org/.*",
     r"https://link\.aps\.org/doi/.*",
     r"https://www\.sciencedirect\.com/science/article/.*",
+    r"https://github.com/unitaryfund/mitiq/compare/.*",
 ]
 
 linkcheck_retries = 3
 
+linkcheck_anchors_ignore_for_url = [
+    "https://github.com/unitaryfund/qrack/blob/main/README.md"
+]
+
 
 class ApsStyle(pybtex.style.formatting.unsrt.Style):
     """Style that mimicks APS journals."""

diff --git a/docs/source/examples/cdr_qrack.md b/docs/source/examples/cdr_qrack.md
@@ -25,7 +25,7 @@ To start, relevant modules and libraries are imported. Please ensure that the fo
 +++
 
 ```{note}
-In the code below the environmental variable, `QRACK_MAX_CPU_QB`, is set to `-1`. This enviroment variable sets the maximum on how many qubits can be allocated on a single QEngineCPU instance. More information can be found on the [Qrack README page](https://github.com/unitaryfund/qrack?tab=readme-ov-file#maximum-allocation-guard).
+In the code below the environmental variable, `QRACK_MAX_CPU_QB`, is set to `-1`. This enviroment variable sets the maximum on how many qubits can be allocated on a single QEngineCPU instance. More information can be found on the [Qrack README page](https://github.com/unitaryfund/qrack/blob/main/README.md#maximum-allocation-guard).
 ```
 
 ```{code-cell}