Ticket #8806 (closed enhancement: fixed)

Opened 3 years ago

Last modified 3 years ago

update the README.txt in sage-4.4.1 to reflect improved platform and compiler support

Reported by: was Owned by: mvngu
Priority: blocker Milestone: sage-4.4.1
Component: documentation Keywords:
Cc: Work issues:
Report Upstream: N/A Reviewers: Minh Van Nguyen
Authors: William Stein Merged in: sage-4.4.1.final
Dependencies: Stopgaps:

Description

With that in mind, you should probably change README.txt.  It is
woefully out of date, and not tracked by HG as far as I can tell.
E.g.,

NOT OFFICIALLY SUPPORTED, BUT NEARLY WORKS
------------------------------------------

PROCESSOR  OPERATING SYSTEM
SPARC      Solaris 10 -- nearly works
x86        Apple Mac OS X 10.6.x (64-bit) -- see trac #7095.
x86_64     Solaris 10 -- does not work
x86_64     Apple Mac OS X 10.5.x (64-bit) -- needs 64-bit gFortran
          instead of g95

It should also say something about removing /sw from your PATH on Mac.

Karl-Dieter

Attachments

README.txt Download (10.5 KB) - added by was 3 years ago.

Change History

comment:1 Changed 3 years ago by was

  • Status changed from new to needs_review
  • Milestone changed from sage-4.4.2 to sage-4.4.1

comment:2 Changed 3 years ago by mvngu

  • Status changed from needs_review to closed
  • Reviewers set to Minh Van Nguyen
  • Resolution set to fixed
  • Authors set to William Stein

Here's the diff between the README.txt in Sage 4.4 and the one in Sage 4.4.1:

  • README-4.4.

    old new  
    55 
    66    ./sage 
    77 
    8 from the command line and you are good to go. If you downloaded the sources, 
    9 please read below on how to build Sage and work around common issues. 
     8from the command line. If you downloaded the sources, please read 
     9below on how to build Sage and work around common issues. 
    1010 
    1111 
    1212--------------------------------------------------------------------------- 
     
    1717          Magma, Maple, Mathematica, and Matlab" 
    1818 
    1919    Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010 
    20     William Stein and The Sage Development Team 
     20    William Stein and the Sage Development Team 
    2121 
    2222    Distributed under the terms of the GNU General Public License (GPL) 
    2323 
     
    2727 
    2828         http://groups.google.com/group/sage-support 
    2929 
    30     AUTHORS: Over 150 people have contributed code to Sage. Please see 
     30    AUTHORS: Over 200 people have contributed code to Sage. Please see 
    3131    one of the websites above for a list. In many cases, documentation 
    3232    for modules and functions list the authors. 
    3333 
     
    4040The following steps briefly outline the process of building Sage from 
    4141source. See below for more detailed instructions. 
    4242 
    43 1. Make sure you have the dependencies and 2 GB of free disk space. 
     431. Make sure you have the dependencies and 2.5 GB of free disk space. 
    4444 
    4545   Linux (install these using your package manager): 
    4646 
     
    8989Building of Sage from source is regularly tested on (minimal installs 
    9090of) the following platforms: 
    9191 
    92 PROCESSOR        OPERATING SYSTEM 
    93 x86              32-bit Linux -- Debian, Ubuntu, CentOS (=Red Hat), 
    94                                  Fedora, openSUSE, Mandriva 
    95 x86_64           64-bit Linux -- Debian, Ubuntu, CentOS (=Red Hat), 
    96                                  Fedora, openSUSE, Mandriva 
    97 IA-64 Itanium 2  64-bit Linux -- Red Hat, SUSE 
    98 x86              Apple Mac OS X 10.5.x 
    99 PPC              Apple Mac OS X 10.5.x 
     92  PROCESSOR        OPERATING SYSTEM 
     93  x86              32-bit Linux -- Debian, Ubuntu, CentOS (=Red Hat), 
     94                                   Fedora, openSUSE, Mandriva, Arch 
     95  x86_64           64-bit Linux -- Debian, Ubuntu, CentOS (=Red Hat), 
     96                                   Fedora, openSUSE, Mandriva, Arch 
     97  IA-64 Itanium 2  64-bit Linux -- Red Hat, SUSE 
     98  x86              Apple Mac OS X 10.5.x, 10.6.x 
     99  PPC              Apple Mac OS X 10.5.x, 10.6.x 
     100  Sparc            Solaris 10 
    100101 
    101 Use Sage on Microsoft Windows via VirtualBox. We do not always test on 
    102 OS X 10.4, but Sage should work there fine. 
     102Use Sage on Microsoft Windows via VMware.  Active work to port Sage to 
     103Cygwin (Windows) is in progress. 
    103104 
     105NOTE: Sage-4.4 worked on OS X 10.4, but Sage-4.4.1 doesn't.  
    104106 
    105107NOT OFFICIALLY SUPPORTED, BUT NEARLY WORKS 
    106108------------------------------------------ 
    107109 
    108 PROCESSOR  OPERATING SYSTEM 
    109 SPARC      Solaris 10 -- nearly works 
    110 x86        Apple Mac OS X 10.6.x (64-bit) -- see trac #7095. 
    111 x86_64     Solaris 10 -- does not work 
    112 x86_64     Apple Mac OS X 10.5.x (64-bit) -- needs 64-bit gFortran 
    113            instead of g95 
     110  PROCESSOR  OPERATING SYSTEM 
     111  x86_64     Solaris 10 -- does not work yet 
    114112 
    115113 
    116114NOT SUPPORTED 
    117115------------- 
    118116 
    119 * AIX 
    120 * Arch Linux 
    121 * FreeBSD 
    122 * Gentoo Linux 
    123 * HP-UX 
    124 * Microsoft Windows (via Cygwin) 
    125 * Microsoft Windows (via Visual Studio C++) 
    126 * OpenSolaris (aka Solaris 11). A port will be completed in 2010. 
     117  * AIX 
     118  * FreeBSD 
     119  * Gentoo Linux -- though Sage will probably work fine 
     120  * HP-UX 
     121  * Microsoft Windows (via Cygwin) -- active port in progress 
     122  * Microsoft Windows (via Visual Studio C++) 
     123  * OpenSolaris 
    127124 
    128125There is some effort to port Sage to FreeBSD and HP-UX. We like all of 
    129126the above operating systems, but just haven't had the time to make 
     
    138135FORTRAN 
    139136------- 
    140137 
    141 If you are using Fortran on a platform for which Sage does not include 
    142 g95 binaries, you must use a system-wide gFortran. For example, Solaris 
    143 10 does not ship with any Fortran binaries. You need to explicitly 
    144 tell the Sage build process about the Fortran compiler and library 
    145 location. Do this by typing 
     138To build Sage on any platform except OS X, you must use a system-wide 
     139gfortran compiler.  Sometimes you need to explicitly tell the Sage 
     140build process about the Fortran compiler and library location. Do this 
     141by typing 
    146142 
    147143    export SAGE_FORTRAN=/exact/path/to/gfortran 
    148144    export SAGE_FORTRAN_LIB=/path/to/fortran/libs/libgfortran.so 
     
    163159-------------- 
    164160 
    165161Sage has significant components written in the following languages: 
    166 C/C++, Python, Lisp, and Fortran. Lisp and Python are built as part of 
    167 Sage and Fortran (g95) is included (x86 Linux and OS X only), so you 
    168 do not need them in order to build Sage. 
     162C/C++, Python, Cython, Lisp, and Fortran. Lisp (ECL) and Python are 
     163built as part of Sage and a GNU Fortran (gfortran) binary is included 
     164(OS X only), so you do not need them in order to build Sage. 
    169165 
    170166 
    171167MORE DETAILED INSTRUCTIONS TO BUILD FROM SOURCE 
    172168----------------------------------------------- 
    173169 
    174 1. Make sure you have about 2 GB of free disk space. 
     1701. Make sure you have about 2.5 GB of free disk space. 
    175171 
    1761722. Linux: Install GCC, g++, m4, ranlib, and make. The build should 
    177173   work fine on openSUSE, Fedora, Ubuntu, etc. If it doesn't, we want 
     
    256252SUPPORTED COMPILERS 
    257253------------------- 
    258254 
    259 * Sage builds with GCC >= 3.x, GCC >= 4.0.1, and GCC >= 4.1.x. 
    260 * Sage will not build with GCC 2.9.x. 
    261 * WARNING: Don't build with GCC 4.0.0, which is very buggy. 
    262 * Sage has never been built without using GCC compiler. 
    263  
    264  
    265 RUNNING SAGE 
    266 ------------ 
    267  
    268 1. Try running Sage: 
    269  
    270        ./sage 
    271  
    272 2. Try running an example Sage script: 
    273  
    274        ./sage example.sage 
     255 * Sage builds with GCC >= 3.x, GCC >= 4.0.1, and GCC >= 4.1.x. 
     256 * Sage will not build with GCC 2.9.x. 
     257 * WARNING: Don't build with GCC 4.0.0, which is very buggy. 
     258 * Sage has never been built without using the GCC compiler. 
    275259 
    276260 
    277261RELOCATION 
     
    308292   installed by typing "sage -bdist x.y.z". The result is placed in 
    309293   the SAGE_ROOT/dist directory. 
    310294 
    311 3. Fat Binaries: This *does not* work at all yet (as of Nov 14, 2009). 
    312    To make a binary that will run on the widest range of target 
    313    machines, set the SAGE_FAT_BINARY environment variable to "yes" 
    314    before building Sage: 
     2953. Fat Binaries: To make a binary that will run on the widest range of 
     296   target machines, set the SAGE_FAT_BINARY environment variable to 
     297   "yes" before building Sage: 
    315298 
    316299       export SAGE_FAT_BINARY="yes" 
    317300       make 
     
    322305---------------------------- 
    323306 
    324307All software included with Sage is copyright by the respective authors 
    325 and released under an open source license that is GPL compatible. See 
    326 the file COPYING.txt for more details. (NOTE: jsMath is licensed 
    327 under the Apache license. Apache claim their license is GPL 
    328 compatible, but Stallman disagrees.) 
     308and released under an open source license that is "GPL version 3 or 
     309later"q compatible. See the file COPYING.txt for more details. 
    329310 
    330311Each spkg in SAGE_ROOT/spkg/standard/ is a bzip'd tarball. You can 
    331312extract it with 

The changes are OK. But I don't understand why there's a "q" appended to the word "later". That is, this line:

+later"q compatible. See the file COPYING.txt for more details.

If it's a typo, it is a trivial typo that can be fixed in Sage 4.4.2. Anyway, the updated README.txt fixes many issues at #7484.

comment:3 Changed 3 years ago by mvngu

  • Merged in set to sage-4.4.1.final

comment:4 Changed 3 years ago by kcrisman

Just a very minor point to go along with Minh's potential followup ticket for the "q":

PPC              Apple Mac OS X 10.5.x, 10.6.x 

is wrong as well, since of course Apple intentionally removed PPC support from OS X 10.6.

Changed 3 years ago by was

Note: See TracTickets for help on using tickets.