Merge pull request #385 from jcapriot/v0.11.1_staging

Staging for 0.11.1

Author: jcapriot

discretize/tests.py

@@ -582,7 +582,7 @@ def check_derivative(
     fctn,
     x0,
     num=7,
-    plotIt=True,
+    plotIt=False,
     dx=None,
     expectedOrder=2,
     tolerance=0.85,

docs/_static/versions.json

@@ -4,11 +4,16 @@
         "url": "https://discretize.simpeg.xyz/en/main/"
     },
     {
-        "name": "0.11.0 (stable)",
-        "version": "v0.11.0",
-        "url": "https://discretize.simpeg.xyz/en/v0.11.0/",
+        "name": "0.11.1 (stable)",
+        "version": "v0.11.1",
+        "url": "https://discretize.simpeg.xyz/en/v0.11.1/",
         "preferred": true
     },
+    {
+        "name": "0.11.0",
+        "version": "v0.11.0",
+        "url": "https://discretize.simpeg.xyz/en/v0.11.0/"
+    },
     {
         "name": "0.10.0",
         "version": "v0.10.0",

docs/content/installing.rst

@@ -23,6 +23,8 @@ You can download the package manager and use it to install the dependencies abov
         conda update conda
         conda update anaconda
 
+.. _discretize_dependencies:
+
 Dependencies
 ============
 
@@ -61,7 +63,8 @@ systems will require a build.
 Installing from Source
 ----------------------
 .. attention::
-    Install ``discretize`` from the source code only if you need to run the development version. Otherwise it's usually better to install it from ``conda-forge``.
+    Install ``discretize`` from the source code only if you need to run the development version.
+    Otherwise it's usually better to install it from ``conda-forge`` or ``pypi``.
 
 As ``discretize`` contains several compiled extensions and is not a pure python pacakge,
 installing ``discretize`` from the source code requires a C/C++ compiler capable of
@@ -88,25 +91,29 @@ Editable Installs
 If you are an active developer of ``discretize``, and find yourself modifying the code often,
 you might want to install it from source, in an editable installation. ``discretize`` uses
 ``meson-python`` to build the external modules and install the package. As such, there are a few extra
-steps to take. First, make sure you have the runtime dependencies installed in your environment (see Dependencies listed above).
-Then you must install some packages needed to build ``discretize`` in your environment. You can do so with ``pip``::
+steps to take:
+
+1. Make sure you have the runtime dependencies installed in your environment (see :ref:`discretize_dependencies` listed above).
+   However, you **must** install ``numpy >=2.0`` when *building* ``discretize``.
+2. You must also install packages needed to build ``discretize`` into your environment. You can do so with ``pip``::
 
-    pip install meson-python meson ninja cython setuptools_scm
+      pip install meson-python meson ninja cython setuptools_scm
 
-Or with ``conda`` (or ``mamba``)::
+   Or with ``conda``::
 
-    conda install -c conda-forge meson-python meson ninja cython setuptools_scm
+      conda install -c conda-forge meson-python meson ninja cython setuptools_scm
 
-This will allow you to use the build backend required by `discretize`.
+   This will allow you to use the build backend required by `discretize`.
 
-Finally, you should then be able to perform an editable install using the source code::
+3. Finally, you should then be able to perform an editable install using the source code::
 
-    pip install --no-build-isolation --editable .
+      pip install --no-build-isolation --editable .
 
 
 This builds and installs the local directory to your active python environment in an
-"editable" mode; when source code is changed, you will be able to make use of it immediately. It also builds against the packages installed
-in your environment instead of creating and isolated environment to build a wheel for the package.
+"editable" mode; when source code is changed, you will be able to make use of it immediately. It also builds against the
+packages installed in your environment instead of creating and isolated environment to build a wheel for the package,
+which is why we needed to install the build requirements into the environment.
 
 Testing your installation
 =========================

docs/release/0.11.1-notes.rst

@@ -0,0 +1,38 @@
+.. currentmodule:: discretize
+
+.. _0.11.1_notes:
+
+===================================
+``discretize`` 0.11.1 Release Notes
+===================================
+
+November 5, 2024
+
+This is a bugfix release for issues found in the previous release, and adds some warning messages for users.
+
+Updates
+=======
+
+Warning Messages
+----------------
+* Added a warning to the `TreeMesh` informing of incoming future behavoir changes regarding
+  diagonal balancing. This will default to ``True`` in `discretize` 1.0.
+* Added warning messages to test functions using uncontrolled randomized input that appear when run under
+  `pytest` or `nosetest`, alerting the user to non-repeatable tests.
+* Changed the default for ``plotIt`` argument to ``False`` for testing functions.
+
+Fixed Bugs
+----------
+* `TreeMesh.point2index` now refers to the correction function.
+
+
+Contributors
+============
+* @jcapriot
+
+Pull requests
+=============
+
+* Outstanding bugfixes. by @jcapriot in `#382 <https://github.com/simpeg/discretize/pull/382>`__.
+* Warn for non-repeatable random tests in a testing environment by @jcapriot in `#384 <https://github.com/simpeg/discretize/pull/384>`__.
+* Staging for 0.11.1 by @jcapriot in `#385 <https://github.com/simpeg/discretize/pull/385>`__.

docs/release/index.rst

@@ -4,6 +4,7 @@ Release Notes
 .. toctree::
    :maxdepth: 2
 
+   0.11.1  <0.11.1-notes>
    0.11.0  <0.11.0-notes>
    0.10.0  <0.10.0-notes>
    0.9.0  <0.9.0-notes>

examples/README.txt

@@ -1,2 +1,4 @@
+.. _sphx_glr_examples:
+
 Examples
-********
+********

pyproject.toml

@@ -9,9 +9,6 @@ requires = [
     # numpy requirement for wheel builds for distribution on PyPI - building
     # against 2.x yields wheels that are also compatible with numpy 1.x at
     # runtime.
-    # Note that building against numpy 1.x works fine too - users and
-    # redistributors can do this by installing the numpy version they like and
-    # disabling build isolation.
     "numpy>=2.0.0rc1",
 ]
 

tests/base/test_tests.py

@@ -170,8 +170,8 @@ def test_import_time():
     # Capture it
     out = subprocess.run(cmd, capture_output=True)
 
-    # Currently we check t < 1.0s.
-    assert float(out.stderr.decode("utf-8")[:-1]) < 1.0
+    # Currently we check t < 1.25s.
+    assert float(out.stderr.decode("utf-8")[:-1]) < 1.25
 
 
 def test_random_test_warning():