Merge pull request #1223 from glotzerlab/release/v3.0.0

Release freud version 3.0.0
glotzerlab · Feb 23, 2024 · 5be15fe · 5be15fe
2 parents 237a27f + 30fbc99
commit 5be15fe
Show file tree

Hide file tree

Showing 10 changed files with 25 additions and 25 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -26,7 +26,7 @@ body:
     attributes:
       label: freud Version
       description: What version of freud are you using?
-      placeholder: v2.13.2
+      placeholder: v3.0.0
     validations:
       required: true
   - type: input

diff --git a/.mailmap b/.mailmap
@@ -61,3 +61,6 @@ DomFijan <[email protected]> Domagoj Fijan <[email protected]
 DomFijan <[email protected]> Domagoj Fijan <[email protected]>
 Dylan Marx <[email protected]> marxd1 <[email protected]>
 Alain Kadar <[email protected]> AlainKadar <[email protected]>
+Alain Kadar <[email protected]> AlainKadar <[email protected]>
+Melody Zhang <[email protected]> Melody Zhang <[email protected]>
+Melody Zhang <[email protected]> yiyuanmz <[email protected]>
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -29,7 +29,7 @@ repos:
       - id: debug-statements
       - id: requirements-txt-fixer
   - repo: https://github.com/glotzerlab/fix-license-header
-    rev: v0.2.0
+    rev: v0.3.2
     hooks:
       - id: fix-license-header
         name: Fix License Headers (Python)
@@ -56,7 +56,7 @@ repos:
           - --add=This file is from the freud project, released under the BSD 3-Clause License.
           - --comment-prefix=//
   - repo: https://github.com/asottile/pyupgrade
-    rev: 'v3.15.0'
+    rev: 'v3.15.1'
     hooks:
       - id: pyupgrade
         args:
@@ -66,11 +66,11 @@ repos:
     hooks:
       - id: isort
   - repo: https://github.com/psf/black
-    rev: '23.12.1'
+    rev: '24.2.0'
     hooks:
       - id: black
   - repo: https://github.com/PyCQA/flake8
-    rev: '6.1.0'
+    rev: '7.0.0'
     hooks:
       - id: flake8
         types: ["file"]

diff --git a/ChangeLog.md b/ChangeLog.md
@@ -4,7 +4,7 @@ The format is based on
 and this project adheres to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## v3.0.0 -- YYYY-MM-DD
+## v3.0.0 -- 2024-02-22
 
 ### Added
 * Coloring plots by polytope area in `freud.locality.Voronoi`.
@@ -17,15 +17,11 @@ and this project adheres to
 * `freud.order.Nematic` uses orientation vectors instead of quaternions and a nematic director.
 * `freud.order.Nematic` raises a warning when the zero is vector passed.
 * Remove zero-padding from arrays in `freud.environment.EnvironmentCluster` and `freud.environment.EnvironmentMotifMatch` and replace with ragged lists of NumPy arrays.
+* Provide support via GitHub discussions.
 
 ### Removed
 * The `global_search` flag in `freud.environment.EnvironmentCluster`.
 
-## vX.Y.Z -- YYYY-MM-DD
-
-### Changed
-* Provide support via GitHub discussions.
-
 ## v2.13.2 -- 2023-11-27
 
 ### Added

diff --git a/contributors.txt b/contributors.txt
@@ -1,28 +1,28 @@
-  2357	Bradley Dice <[email protected]>
+  2373	Bradley Dice <[email protected]>
   2148	Vyas Ramasubramani <[email protected]>
   1030	Eric Harper <[email protected]>
-   833	Tommy Waltmann <[email protected]>
+  1000	Tommy Waltmann <[email protected]>
    456	Jin Soo Ihm <[email protected]>
-   325	Joshua A. Anderson <[email protected]>
-   253	dependabot <dependabot[bot]@users.noreply.github.com>
+   328	Joshua A. Anderson <[email protected]>
+   275	dependabot <dependabot[bot]@users.noreply.github.com>
    240	Matthew Spellings <[email protected]>
-   173	DomFijan <[email protected]>
+   202	DomFijan <[email protected]>
    167	Kelly Wang <[email protected]>
    110	Erin Teich <[email protected]>
     98	Brandon Butler <[email protected]>
     94	Charlotte Shiqi Zhao <[email protected]>
-    78	pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
+    94	pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
     66	M. Eric Irrgang <[email protected]>
     53	Chrisy Du <[email protected]>
     41	Yezhi Jin <[email protected]>
     40	Antonio Osorio <[email protected]>
     35	Michael Stryk <[email protected]>
     31	Richmond Newman <[email protected]>
+    28	Alain Kadar <[email protected]>
     26	Andrew Kerr <[email protected]>
     25	Andrew Kerr <[email protected]>
     25	Carl Simon Adorf <[email protected]>
     22	Jens Glaser <[email protected]>
-    21	Alain Kadar <[email protected]>
     20	Tim Moore <[email protected]>
     18	Kody Takada <[email protected]>
     13	Pavel Buslaev <[email protected]>
@@ -33,6 +33,7 @@
      9	Mike Henry <[email protected]>
      9	SyedZiaul <[email protected]>
      8	Fengyi Gao <[email protected]>
+     8	Melody Zhang <[email protected]>
      8	Ryan Marson <[email protected]>
      6	Allen LaCour <[email protected]>
      6	James Proctor <[email protected]>

diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -72,8 +72,8 @@
 # built documents.
 #
 # version and release are set the same for this package.
-version = "2.13.2"
-release = "2.13.2"
+version = "3.0.0"
+release = "3.0.0"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.

diff --git a/doc/source/gettingstarted/examples b/doc/source/gettingstarted/examples
diff --git a/freud/__init__.py b/freud/__init__.py
@@ -23,7 +23,7 @@
 # automatic selection runs, the user cannot change it.
 set_num_threads(0)
 
-__version__ = "2.13.2"
+__version__ = "3.0.0"
 
 __all__ = [
     "__version__",

diff --git a/setup.cfg b/setup.cfg
@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 2.13.2
+current_version = 3.0.0
 commit = True
 tag = False
 message = Bump up to version {new_version}.
@@ -11,7 +11,7 @@ force-check = True
 exclude = .eggs,*.egg,build,extern,doc/source/gettingstarted/examples
 select = E,F,W
 ignore = E203,E225,E226,E227,E402,E741,E999,W503,W504
-per-file-ignores =
+per-file-ignores = 
 	freud/__init__.py: F401
 	freud/*.pxd: E402
 

diff --git a/setup.py b/setup.py
@@ -5,7 +5,7 @@
 
 from skbuild import setup
 
-version = "2.13.2"
+version = "3.0.0"
 
 # Read README for PyPI, fallback to short description if it fails.
 description = "Powerful, efficient trajectory analysis in scientific Python."
+3 −1		.github/workflows/test.yml
+2 −2		environment.yml
+13 −17		examples/Calculating RDF from GSD files.ipynb
+46 −29		examples/Identifying Local Environments in a Complex Crystal.ipynb
+19,145 −0		examples/Smectic.ipynb
+2 −0		module_intros/density.LocalDensity.ipynb
+7 −11		module_intros/density.RDF-AccumulateFluid.ipynb
+2 −0		module_intros/density.RDF-BinWidth.ipynb
+8 −15		module_intros/environment.EnvironmentCluster.ipynb
+15 −17		module_intros/locality.Filter.ipynb
+36,794 −203		module_intros/order.Nematic.ipynb