Skip to content

Commit

Permalink
gh-38504: Demote jmol to optional
Browse files Browse the repository at this point in the history
    
<!-- ^ Please provide a concise and informative title. -->
<!-- ^ Don't put issue numbers in the title, do this in the PR
description below. -->
<!-- ^ For example, instead of "Fixes #12345" use "Introduce new method
to calculate 1 + 2". -->
<!-- v Describe your changes below in detail. -->
<!-- v Why is this change required? What problem does it solve? -->
<!-- v If this PR resolves an open issue, please link to it here. For
example, "Fixes #12345". -->

- Resolves #31027

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->

- [x] The title is concise and informative.
- [ ] The description explains in detail what this PR is about.
- [x] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [x] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - #12345: short description why this is a dependency -->
<!-- - #34567: ... -->
    
URL: #38504
Reported by: Matthias Köppe
Reviewer(s): Nathan Dunfield
  • Loading branch information
Release Manager committed Sep 13, 2024
2 parents 280d511 + 4d1c2d7 commit 9a30984
Show file tree
Hide file tree
Showing 8 changed files with 5 additions and 70 deletions.
2 changes: 1 addition & 1 deletion build/pkgs/jmol/type
Original file line number Diff line number Diff line change
@@ -1 +1 @@
standard
optional
2 changes: 1 addition & 1 deletion build/pkgs/sagemath_doc_html/dependencies
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
sagelib sphinx sphinx_copybutton sphinx_inline_tabs pplpy_doc | $(SAGERUNTIME) maxima networkx scipy sympy matplotlib pillow mathjax mpmath ipykernel jupyter_client conway_polynomials tachyon jmol ipywidgets sage_docbuild elliptic_curves furo fpylll graphs
sagelib sphinx sphinx_copybutton sphinx_inline_tabs pplpy_doc | $(SAGERUNTIME) maxima networkx scipy sympy matplotlib pillow mathjax mpmath ipykernel jupyter_client conway_polynomials tachyon ipywidgets sage_docbuild elliptic_curves furo fpylll graphs

# Building the documentation has many dependencies, because all
# documented modules are imported and because we use matplotlib to
Expand Down
2 changes: 1 addition & 1 deletion build/pkgs/sagetex/dependencies_check
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
$(SAGERUNTIME) sympy elliptic_curves jmol
$(SAGERUNTIME) sympy elliptic_curves

To build SageTeX, you just need Python, but to test (SAGE_CHECK=yes)
SageTeX, you actually need to run Sage, produce plots,...
Expand Down
29 changes: 0 additions & 29 deletions src/doc/en/faq/faq-usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -479,35 +479,6 @@ How do I run sage in daemon mode, i.e. as a service?
There are several possibilities. Use ``screen``, ``nohup`` or ``disown``.


The show command for plotting 3-D objects does not work.
""""""""""""""""""""""""""""""""""""""""""""""""""""""""

The default live 3-D plotting for Sage 6.4+ uses
`Jmol/JSmol <http://jmol.sourceforge.net>`_
for viewing. From the command line the Jmol Java application is used,
and for in browser viewing either pure javascript or a Java applet
is used. By default in browsers pure javascript is used to avoid
the problems with some browsers that do not support java applet
plugins (namely Chrome). On each browser worksheet there is a
checkbox which must be checked before a 3-D plot is generated if
the user wants to use the Java applet (the applet is a little faster
with complex plots).

The most likely reason for a malfunction is that you do not have
a Java Run Time Environment (JRE) installed or you have one older than
version 1.7. If things work from the command line another possibility
is that your browser does not have the proper plugin to support Java
applets (at present, 2014, plugins do not work with most versions of
Chrome). Make sure you have installed either the IcedTea browser
plugin (for linux see your package manager), see:
`IcedTea <http://icedtea.classpath.org/wiki/IcedTea-Web>`_,
or the Oracle Java plugin see:
`Java <https://java.com/en/download/help/index_installing.xml>`_.

If you are using a Sage server over the web and even javascript rendering
does not work, you may have a problem with your browser's javascript
engine or have it turned off.

May I use Sage tools in a commercial environment?
"""""""""""""""""""""""""""""""""""""""""""""""""

Expand Down
5 changes: 0 additions & 5 deletions src/doc/en/prep/Symbolics-and-Basic-Plotting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -384,11 +384,6 @@ Below, you can experiment with several of the plotting options.
Basic 3D Plotting
-----------------

There are several mechanisms for viewing three\-dimensional plots in
Sage, but we will stick to the default option in the notebook interface,
which is via javascript applets from the program `Jmol/JSmol
<http://jmol.sourceforge.net/>`_ .

Plotting a 3D plot is similar to plotting a 2D plot, but we need to
specify ranges for two variables instead of one.

Expand Down
31 changes: 0 additions & 31 deletions src/doc/it/faq/faq-usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -469,37 +469,6 @@ Ci sono parecchie possibilità. Puoi usare i programmi a riga di comando
``screen``, ``nohup`` o ``disown``.


Il comando show (mostra) per la visualizzazione di oggetti 3D non funziona.
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""

La visualizzazione 3D in tempo reale per Sage dalla versione 6.4 in
avanti usa il pacchetto `Jmol/JSmol <http://jmol.sourceforge.net>`_.
Dalla linea di comando viene utilizzata l'applicazione Java Jmol,
mentre per la visualizzazione dal browser viene usato puro javascript
oppure una Java applet. In genere nei browser è usato javascript puro
per evitare problemi con quei browser che non supportano i plugin per
le applet Java (ad esempio Chrome). In ogni worksheet su browser c'è
una casella da spuntare prima di generare una vista tridimensionale
qualora l'utente voglia usare l'applet Java (essa è un po' più veloce
con viste complicate).

La ragione più probabile di un malfunzionamento è che non hai
installato l'ambiente runtime di Java (JRE) o che è più vecchio della
versione 1.7. Se le cose funzionano dalla riga di comando,
un'altra possibilità è che il tuo browser non abbia il plugin giusto
per supportare le Java applet (al momento, nel 2014, tali plugin non
lavorano con la maggior parte delle versioni di Chrome). Assicurati di
aver installato il plugin IcedTea (su Linux vedi il tuo gestore dei
pacchetti) o il plugin di Oracle Java
(vedi: `IcedTea <http://icedtea.classpath.org/wiki/IcedTea-Web>`_
e `Java <https://java.com/en/download/help/index_installing.xml>`_).

Se stai usando un server Sage sul web e anche la visualizzazione
tramite javascript non funziona, potresti avere un problema con la
funzionalità javascript del tuo browser, o potresti aver disabilitato
javascript.


Posso usare gli strumenti di Sage in un ambiente commerciale?
"""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""

Expand Down
2 changes: 1 addition & 1 deletion src/sage/features/jmol.py
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ def __init__(self):
filename='JmolData.jar',
search_path=jmol_search_path,
spkg='jmol',
type='standard',
type='optional',
description="Java viewer for chemical structures in 3D")


Expand Down
2 changes: 1 addition & 1 deletion src/sage/graphs/graph.py
Original file line number Diff line number Diff line change
Expand Up @@ -362,7 +362,7 @@
sage: G = graphs.RandomGNP(15,.3)
sage: G.show() # needs sage.plot
And you can view it in three dimensions via jmol with ``show3d()``. ::
And you can view it in three dimensions with ``show3d()``. ::
sage: G.show3d() # needs sage.plot
Expand Down

0 comments on commit 9a30984

Please sign in to comment.