Skip to content

Commit

Permalink
sagemathgh-38485: Updated SPKG links for polymake as per sagemath#37532
Browse files Browse the repository at this point in the history
    
This PR updates the SPKG links for the `polymake` package in the
documentation. The goal is to provide users with direct links to the
Sage Reference Manual for installing optional packages, as suggested in
issue sagemath#37532.

**Changes Made:**
- Replaced ad-hoc package installation instructions with links to the
SPKG pages for packages like `4ti2`, `latte_int`, `topcom`, and `qhull`.
- Updated instructions to include links for additional software and the
`jupymake` package.
- Provided instructions for debugging installation problems.

**Why is this change required?**
This change aligns the documentation with the latest recommendations and
practices for installing optional packages in Sage, making it easier for
users to find and follow the correct installation instructions.

**Issue Reference:**
- Resolves issue
[sagemath#37532](https://github.com/YourRepo/YourProject/issues/37532).

### 📝 Checklist

- [x] The title is concise and informative.
- [x] 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.
- [ ] I have updated the documentation and checked the documentation
preview.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on. For example,
-->
<!-- - sagemath#12345: short description why this is a dependency -->
<!-- - sagemath#34567: ... -->
    
URL: sagemath#38485
Reported by: Anant Shukla
Reviewer(s):
  • Loading branch information
Release Manager committed Aug 27, 2024
2 parents 1d9ac17 + 0e9856e commit b3c8a32
Showing 1 changed file with 12 additions and 9 deletions.
21 changes: 12 additions & 9 deletions build/pkgs/polymake/SPKG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -50,25 +50,28 @@ you will need the ``local::lib`` Perl module installed::

cpan -i XML::Writer XML::LibXML XML::LibXSLT File::Slurp Term::ReadLine::Gnu JSON SVG MongoDB

Several Sage packages should be installed before installing the ``polymake``
package to give a more featureful Polymake installation::
Before installing the ``polymake`` package, refer to the SPKG pages for the following packages to ensure a more featureful Polymake installation:

sage -i 4ti2 latte_int topcom qhull
- [4ti2](https://doc.sagemath.org/html/en/reference/spkg/4ti2.html)
- [latte_int](https://doc.sagemath.org/html/en/reference/spkg/latte_int.html)
- [topcom](https://doc.sagemath.org/html/en/reference/spkg/topcom.html)
- [qhull](https://doc.sagemath.org/html/en/reference/spkg/qhull.html)

Software that would need to be installed manually (no Sage package
available) for a more featureful Polymake installation: ``azove``, ``porta``,
``vinci``, ``SplitsTree4``.
For additional software that may enhance your Polymake installation (but for which no Sage package is available), you can manually install the following:

- ``azove``
- ``porta``
- ``vinci``
- ``SplitsTree4``

Information on missing Polymake prerequisites after installing polymake::

$ sage -sh
(sage-sh) $ polymake
polytope> show_unconfigured;

In order to use Polymake from Sage, you will also need the ``jupymake``
package::
In order to use Polymake from Sage, please refer to the [Jupymake SPKG page](https://doc.sagemath.org/html/en/reference/spkg/jupymake.html) for installation instructions.

sage -i jupymake


Debugging polymake install problems
Expand Down

0 comments on commit b3c8a32

Please sign in to comment.