Skip to content

Commit 9fce44b

Browse files
committed
Add #962 to release notes
- Document minimum JRE for JPype 1.6. - Add JPype to intersphinx inventories.
1 parent f89c696 commit 9fce44b

File tree

3 files changed

+26
-12
lines changed

3 files changed

+26
-12
lines changed

RELEASE_NOTES.rst

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
.. Next release
2-
.. ============
1+
Next release
2+
============
33

4-
.. All changes
5-
.. -----------
4+
All changes
5+
-----------
6+
7+
- Document the :ref:`minimum version of Java <install-java>` required for :class:`ixmp.JDBCBackend <ixmp.backend.jdbc.JDBCBackend>` (:pull:`962`).
68

79
.. _v3.11.1:
810

doc/conf.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -197,6 +197,7 @@ def local_inv(name: str, *parts: str) -> Optional[str]:
197197
"https://docs.messageix.org/projects/ixmp/en/latest/",
198198
(local_inv("ixmp"), None),
199199
),
200+
"jpype": ("https://jpype.readthedocs.io/en/stable", None),
200201
"message-ix-models": (
201202
"https://docs.messageix.org/projects/models/en/latest/",
202203
None,

doc/install-adv.rst

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -57,16 +57,26 @@ of which the most popular is OpenJDK.
5757
- `Zulu <https://www.azul.com/downloads/?package=jre#zulu>`_.
5858
- `Corretto <https://aws.amazon.com/corretto/>`_.
5959

60-
.. caution::
60+
.. caution::
6161

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

69-
We recommend one of the above, non-Oracle alternatives, which do not use paid licensing.
69+
We recommend one of the above, non-Oracle alternatives, which do not use paid licensing.
70+
71+
- JDBCBackend uses the :mod:`jpype` package (`‘JPype1’`_ on PyPI) to interact with the JRE.
72+
73+
From JPype version 1.6.0 (released 2025-07-07),
74+
:ref:`its requirements <jpype:userguide:key requirements>` include **JRE version 11 or greater**.
75+
You **should** use such a JRE version;
76+
in general it is good practice to use the *latest* available version.
77+
78+
If it is only possible to use JRE version 8,
79+
then install JPype version 1.5.2 or earlier.
7080

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

0 commit comments

Comments
 (0)