Skip to content
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
14 changes: 14 additions & 0 deletions .github/workflows/pytest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,13 @@ jobs:
# Work around ts-graphviz/setup-graphviz#630
if: matrix.os != 'macos-13'

- name: Set Java version on Windows
if: startsWith(matrix.os, 'windows-')
uses: actions/setup-java@v4
with:
distribution: temurin
java-version: '21'

- name: Cache GAMS installer
uses: actions/cache@v4
with:
Expand Down Expand Up @@ -172,6 +179,13 @@ jobs:
enable-cache: true
python-version: ${{ env.python-version }}

- name: Set Java version on Windows
if: startsWith(matrix.os, 'windows-')
uses: actions/setup-java@v4
with:
distribution: temurin
java-version: '21'

- name: Set RETICULATE_PYTHON
# Retrieve the Python executable set up above
run: echo "RETICULATE_PYTHON=$(uv python find)" >> "$GITHUB_ENV"
Expand Down
10 changes: 6 additions & 4 deletions RELEASE_NOTES.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
.. Next release
.. ============
Next release
============

.. All changes
.. -----------
All changes
-----------

- Document the :ref:`minimum version of Java <install-java>` required for :class:`ixmp.JDBCBackend <ixmp.backend.jdbc.JDBCBackend>` (:pull:`962`).

.. _v3.11.1:

Expand Down
1 change: 1 addition & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,7 @@ def local_inv(name: str, *parts: str) -> Optional[str]:
"https://docs.messageix.org/projects/ixmp/en/latest/",
(local_inv("ixmp"), None),
),
"jpype": ("https://jpype.readthedocs.io/en/stable", None),
"message-ix-models": (
"https://docs.messageix.org/projects/models/en/latest/",
None,
Expand Down
27 changes: 19 additions & 8 deletions doc/install-adv.rst
Original file line number Diff line number Diff line change
Expand Up @@ -57,16 +57,26 @@ of which the most popular is OpenJDK.
- `Zulu <https://www.azul.com/downloads/?package=jre#zulu>`_.
- `Corretto <https://aws.amazon.com/corretto/>`_.

.. caution::
.. caution::

Oracle provides releases branded simply “Java” at https://www.java.com,
as well as `Oracle OpenJDK builds <https://jdk.java.net/>`_.
Not all of these are free to use;
for instance, use by several people in the same organization may require a paid license.
`This news article <https://www.theregister.com/2025/05/09/users_advised_to_review_oracle_java_use/>`__ and other coverage
explain how license fee demands may come as a surprise to users.
Oracle provides releases branded simply “Java” at https://www.java.com,
as well as `Oracle OpenJDK builds <https://jdk.java.net/>`_.
Not all of these are free to use;
for instance, use by several people in the same organization may require a paid license.
`This news article <https://www.theregister.com/2025/05/09/users_advised_to_review_oracle_java_use/>`__ and other coverage
explain how license fee demands may come as a surprise to users.

We recommend one of the above, non-Oracle alternatives, which do not use paid licensing.
We recommend one of the above, non-Oracle alternatives, which do not use paid licensing.

- JDBCBackend uses the :mod:`jpype` package (`‘JPype1’`_ on PyPI) to interact with the JRE.

From JPype version 1.6.0 (released 2025-07-07),
:ref:`its requirements <jpype:userguide:key requirements>` include **JRE version 11 or greater**.
You **should** use such a JRE version;
in general it is good practice to use the *latest* available version.

If it is only possible to use JRE version 8,
then install JPype version 1.5.2 or earlier.

If using Anaconda or Miniconda, installing a JDK/JRE manually is *not required*.
This is because the ``message-ix`` conda-forge package depends on the `openjdk <https://anaconda.org/conda-forge/openjdk>`_ package,
Expand Down Expand Up @@ -481,6 +491,7 @@ See the `Git documentation`_ for more details.
.. _`Graphviz`: https://www.graphviz.org/
.. _`its conda-forge package`: https://anaconda.org/conda-forge/graphviz
.. _`Graphviz download page`: https://www.graphviz.org/download/
.. _`‘JPype1’`: https://pypi.org/project/jpype1
.. _`conda`: https://docs.conda.io/projects/conda/en/stable/
.. _`IIASA YouTube channel`: https://www.youtube.com/user/IIASALive
.. _`Miniconda`: https://docs.conda.io/projects/conda/en/latest/user-guide/install/index.html
Expand Down
Loading