You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+56-39
Original file line number
Diff line number
Diff line change
@@ -8,81 +8,98 @@
8
8
[FriCAS](https://fricas.github.io) is a general purpose computer algebra
9
9
system (CAS).
10
10
11
-
In this work-in-progress repository, wrappers to some [Julia](https://julialang.org)
12
-
specific operations are added to FriCAS. It supports SBCL or Clozure CL build but, as of now, only Julia 1.10.0 is
13
-
supported for a SBCL based FriCAS, see [Caveats](#caveats). It should not be considered production-ready.
11
+
In this work-in-progress repository, a C wrapper using libjulia is embedded in FriCAS to support some [Julia](https://julialang.org) based specific operations (for example, system optimized BLAS and LAPACK libraries). It supports SBCL (preferred) and Clozure CL build, but only Julia 1.10.0 and Julia 1.11.0-alpha* or -beta* are supported with SBCL, see [Caveats](#caveats). It must not be considered production-ready.
14
12
15
13
## Building and Installing
16
14
17
15
For general installation instructions see INSTALL. For general documentation
18
16
consult <https://fricas.github.io>.
19
17
20
-
To build FriCAS with Julia support, a simple
21
-
<code>./configure --enable-julia</code> should do the trick. The required Julia packages are Suppressor, Nemo and SpecialFunctions. If you want to visualize your data, small support is provided using Plots and eventually LaTeXStrings Julia packages .
18
+
To build FriCAS with Julia support, the <code>julia</code> executable needs to be available in your PATH, and a simple <code>./configure --enable-julia</code> should do the trick. The required Julia packages are Suppressor, Nemo and SpecialFunctions. As of now with Clozure CL [queues](https://github.com/oconnore/queues) is also required. Use installed [quicklisp](https://www.quicklisp.org/beta/) with `queues`, and at configure time, if necessary, use the `--with-quicklisp` option, see the `quicklisp` documentation. If you want to visualize your data using Julia, small support is provided using StatsPlots and eventually the LaTeXStrings Julia packages. See the available FriCAS packages below.
22
19
23
-
The <code>julia</code> executable needs to be available in your PATH.
24
-
If you want to add Jupyter support with a SBCL based FriCAS, make sure [hunchentoot](https://edicl.github.io/hunchentoot/) is installed, and as of now on Clozure CL [queues](https://github.com/oconnore/queues) is also required (use installed [quicklisp](https://www.quicklisp.org/beta/) with `queues` at configure time if necessary, see the `quicklisp` documentation).
20
+
If you want to add Jupyter support with a SBCL based FriCAS, make sure [hunchentoot](https://edicl.github.io/hunchentoot/) is installed. On a Debian like system you can add `hunchentoot` with <code>sudo apt install cl-hunchentoot</code> and issue, for example, <code>./configure --enable-gmp --enable-julia --enable-hunchentoot</code>.
25
21
26
-
On a Debian like system you can add `hunchentoot` with <code>sudo apt install cl-hunchentoot</code>
After building FriCAS, and before the installation, issue in the terminal
116
+
After building FriCAS, and before the installation, issue in your terminal
100
117
<code>make htmldoc</code>.
101
118
102
119
## Description
@@ -132,4 +149,4 @@ Current development goals:
132
149
133
150
## Caveats
134
151
135
-
Julia support with SBCL is erratic, depending on the Julia version used. The 1.10.0 version seems to have solved problems related to memory management interactions with SBCL, but with Julia 1.10.1 and 1.10.2 problems occur again. Note that with Julia 1.11.0-alpha2, FriCAS seems to work fine. More work needs to be done in this regards. So, if you use SBCL to build FriCAS, imperatively use a version of Julia that is known to be compatible.
152
+
Julia support with FriCAS built with SBCL is/was erratic, depending on the Julia version used. The 1.10.0 version seems to have solved problems related to memory management interactions with SBCL, but with Julia 1.10.1 and 1.10.2 problems occur again. Note that with Julia 1.11.0-alpha* and later, FriCAS seems to work fine again. More work needs to be done in this regard. So, if you use SBCL to build FriCAS, imperatively use a version of Julia that is known to be compatible.
0 commit comments