Skip to content

Commit 8b51e5e

Browse files
authored
Update JRE text/links in docs (#948; closes #889)
1 parent 9491eb5 commit 8b51e5e

File tree

1 file changed

+33
-9
lines changed

1 file changed

+33
-9
lines changed

doc/install-adv.rst

Lines changed: 33 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -38,15 +38,39 @@ Before making this choice, see :ref:`install-pip-or-conda`, below, for further c
3838
Java (required)
3939
---------------
4040

41-
A `Java Runtime Environment (JRE) <https://en.wikipedia.org/wiki/Java_(software_platform)#Java_Runtime_Environment>`_ is required to use the current default :class:`ixmp.JDBCBackend <ixmp.backend.jdbc.JDBCBackend>` in the :mod:`ixmp` package that handles data storage for :mod:`message_ix`.
42-
43-
Common ways to install Java include:
44-
45-
- Use the official releases of `Java <https://www.java.com>`_.
46-
- Use a version of Java bundled or packaged for your operating system (for example, Ubuntu and other Linux distributions).
47-
48-
If using Anaconda or Miniconda, installing Java manually is *not required*.
49-
This is because the ``message-ix`` conda-forge package depends on the `openjdk <https://anaconda.org/conda-forge/openjdk>`_ package, so the latter is automatically installed with the former.
41+
A `Java Runtime Environment (JRE) <https://en.wikipedia.org/wiki/Java_(software_platform)#Java_Runtime_Environment>`_ is required
42+
to use :class:`ixmp.JDBCBackend <ixmp.backend.jdbc.JDBCBackend>`,
43+
the current default in the :mod:`ixmp` package that handles data storage for :mod:`message_ix`.
44+
45+
There are many ways to install a JRE.
46+
Most often this is done by installing a Java Development Kit (JDK),
47+
of which the most popular is OpenJDK.
48+
49+
- Linux operating systems like Ubuntu often have specific packages containing OpenJDK/the JRE,
50+
with names like ``openjdk-25-jre``.
51+
- OpenJDK is also `built and packaged by many providers <https://en.wikipedia.org/wiki/OpenJDK#OpenJDK_builds>`_;
52+
these packages are known by different names
53+
and are available for operating systems including Windows and macOS.
54+
Some of these known to work with JDBCBackend include:
55+
56+
- `Temurin <https://adoptium.net/temurin/releases/>`_.
57+
- `Zulu <https://www.azul.com/downloads/?package=jre#zulu>`_.
58+
- `Corretto <https://aws.amazon.com/corretto/>`_.
59+
60+
.. caution::
61+
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.
68+
69+
We recommend one of the above, non-Oracle alternatives, which do not use paid licensing.
70+
71+
If using Anaconda or Miniconda, installing a JDK/JRE manually is *not required*.
72+
This is because the ``message-ix`` conda-forge package depends on the `openjdk <https://anaconda.org/conda-forge/openjdk>`_ package,
73+
so the latter is automatically installed with the former.
5074

5175

5276
.. _install-gams:

0 commit comments

Comments
 (0)