Skip to content

Commit

Permalink
More edits; remove cross references to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
kwankyu committed Sep 20, 2024
1 parent a883a8f commit 34af750
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 40 deletions.
21 changes: 10 additions & 11 deletions src/doc/en/installation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,15 @@ services that offer free access to Sage:

If none of these sounds interesting to you, you are welcome! Please read on.

This installation guide offers comprehensive information on installing Sage of the
version specified on the left, below the logo. Make it sure that the version
does match with the version you plan to install.

Up-to-date information and details regarding installation on supported
platforms may be available in the section "Availability and installation help"
of the `Release Tour <https://github.com/sagemath/sage/releases>`_ for each
Sage version.

There are various ways you can install Sage depending on how you plan to use it
This installation guide offers comprehensive information on installing Sage,
of the version specified on the left, below the logo, or of any recent
versions. However, you may need to check additional information and details
regarding installation on supported platforms available in the section
"Availability and installation help" of the `Release Tour
<https://github.com/sagemath/sage/releases>`_ for the Sage version you plan to
install.

There are alternative ways you can install Sage depending on how you plan to use it
and depending on your platform. So start in the relevant section below.

.. _installation-guide-windows:
Expand Down Expand Up @@ -69,7 +68,7 @@ Start Ubuntu from the Start menu. You will see the command line prompt ``$``.

**I don't want to do Sage development:** Then follow instructions in
:ref:`sec-installation-conda` and :ref:`sec-installation-conda-binary`. This is
the easiest way of using Sage in the terminal. Then see :ref:`sec-launching` for
the easiest way of using Sage in the terminal. Then see :ref:`sec-post-installation` for
recommended next steps, in particular for setting up the Jupyter notebook,
which is convenient if you want to use graphics.

Expand Down
23 changes: 10 additions & 13 deletions src/doc/en/installation/launching.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.. _sec-launching:
.. _sec-post-installation:

Post installation
=================
Expand Down Expand Up @@ -41,8 +41,8 @@ detect whether the default port is already taken by another instance of
Jupyter running in Windows.


Environment variables
---------------------
Run-time environment variables
------------------------------

Sage uses the following environment variables when it runs:

Expand Down Expand Up @@ -90,7 +90,8 @@ Note that this assumes that a firewall which might be present between server
and client allows connections on port 8888. See details on port forwarding on
the internet, e.g. https://www.ssh.com/ssh/tunneling/example.

.. _sec-launching-wsl-post-installation:

.. _sec-post-installation-wsl:

WSL post-installation steps
---------------------------
Expand All @@ -99,7 +100,7 @@ If you've installed Sage from source on WSL, there are a couple of extra steps y


Create a notebook launch script
"""""""""""""""""""""""""""""""
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

If you plan to use JupyterLab, install that first.

Expand Down Expand Up @@ -132,7 +133,7 @@ Run it to test:
The Jupyter(Lab) server should start in the terminal window, and you windows browser should open a page showing the Jupyter or JupyterLab starting page, at the directory you specified.

Create a shortcut
"""""""""""""""""
^^^^^^^^^^^^^^^^^

This is a final nicety that lets you start the Jupyter or JupyterLab server in one click:

Expand All @@ -154,13 +155,8 @@ This is a final nicety that lets you start the Jupyter or JupyterLab server in o

Now hit the start button or key and type the name you gave it. it should appear in the list, and should load the server and fire up your browser when you click on it.

------------------------------------------------------------------------

For further reading you can have a look at the other documents in the
Sage documentation at http://doc.sagemath.org/.


.. _sec-launching-system-jupyter:
.. _sec-post-installation-system-jupyter:

Setting up Sage as a Jupyter kernel in an existing Jupyter installation
-----------------------------------------------------------------------
Expand Down Expand Up @@ -278,8 +274,9 @@ You can check the presence of some of these packages using the command

plot3d(lambda u,v:(u^2+v^2)/4-2,(-2,2),(-2,2)).show(viewer="jmol")


Using Jupyter notebook through Visual Studio Code (VS Code) in WSL
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""
------------------------------------------------------------------

If you have installed Sage on Windows using Windows Subsystem for
Linux (WSL), it is convenient to use Visual Studio Code (VS Code)
Expand Down
27 changes: 11 additions & 16 deletions src/doc/en/installation/source.rst
Original file line number Diff line number Diff line change
Expand Up @@ -283,7 +283,7 @@ Also see the `related Github issue <https://github.com/pypa/packaging-problems/i
WSL post-installation notes
~~~~~~~~~~~~~~~~~~~~~~~~~~~

When the installation is complete, you may be interested in :ref:`sec-launching-wsl-post-installation`.
When the installation is complete, you may be interested in :ref:`sec-post-installation-wsl`.


Pre-build remarks
Expand Down Expand Up @@ -729,9 +729,7 @@ The instructions cover all of Linux, macOS, and WSL.

17. Optional: Set up Sage as a Jupyter kernel in an existing Jupyter
notebook or JupyterLab installation, as described in the section
`Launching
SageMath <https://doc.sagemath.org/html/en/installation/launching.html>`__
in the Sage Installation Guide.
:ref:`sec-post-installation`.


Post-build remarks
Expand Down Expand Up @@ -1455,9 +1453,9 @@ a single copy of Sage in a multi-user computer network.
$ sudo chown $(id -un) SAGE_LOCAL
$ sudo chmod 755 SAGE_LOCAL

#. Build and install Sage, following the instructions in `README.md
<https://github.com/sagemath/sage/#readme>`_, using the
``configure`` option ``--prefix=SAGE_LOCAL``.
#. Build Sage, following the instructions in
:ref:`build-from-source-step-by-step`, using the option
``--prefix=SAGE_LOCAL`` for ``configure``.

Do not use ``sudo`` for this step; building Sage must be done using
your normal user account.
Expand Down Expand Up @@ -1589,11 +1587,9 @@ In the new worktree, we now build Sage from scratch. This
is completely independent of and will not disrupt your
existing working installation in the main worktree.

We will refer again to the step-by-step instructions
from the file
`README.md <https://github.com/sagemath/sage/#readme>`_.
Our worktree ``worktree-purple`` is the ``SAGE_ROOT``
for this purpose.
We will refer again to the step-by-step instructions in
:ref:`build-from-source-step-by-step`. Our worktree ``worktree-purple`` is the
``SAGE_ROOT`` for this purpose.

One thing that we can share between worktrees without
worry is the directory ``upstream``, where Sage caches
Expand All @@ -1608,9 +1604,8 @@ Now let's build Sage, starting with the step::

[alice@localhost worktree-purple]$ make configure

Refer to the file `README.md <https://github.com/sagemath/sage/#readme>`_
for the following steps.

Refer to the section :ref:`build-from-source-step-by-step` for the following
steps.

Relocation
----------
Expand Down Expand Up @@ -1762,7 +1757,7 @@ Simplified directory layout (only essential files/directories):
│ └── *.m4
├── Makefile Running "make" uses this file
├── prefix -> SAGE_LOCAL Convenience symlink to the installation tree
├── README.md This file
├── README.md
├── sage Script to start Sage
├── src Monolithic Sage library source tree
│ ├── bin/ Scripts that Sage uses internally
Expand Down

0 comments on commit 34af750

Please sign in to comment.