Skip to content

Commit 8fbd506

Browse files
authored
Update README.md
1 parent c260296 commit 8fbd506

File tree

1 file changed

+32
-24
lines changed

1 file changed

+32
-24
lines changed

README.md

+32-24
Original file line numberDiff line numberDiff line change
@@ -15,34 +15,36 @@ In this work-in-progress repository, a C wrapper using libjulia is embedded in F
1515
For general installation instructions see INSTALL. For general documentation
1616
consult <https://fricas.github.io>.
1717

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.
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 for how to load it and install `queues`. 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.
1919

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>.
20+
If you want to use [jFriCAS](https://jfricas.readthedocs.io/en/latest/) i.e. Jupyter support for FriCAS built with SBCL, 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>.
2121

2222
To know which categories/domains/packages are added to FriCAS issue in the
2323
FriCAS interpreter <code>)what things julia</code> and/or <code>)what things nemo</code> or use HyperDoc:
2424

2525
```
2626
(1) -> )what things julia
27-
Operations whose names satisfy the above pattern(s):
2827
29-
juliaCMPrint juliaCVPrint juliaIVPrint juliaMPrint
30-
juliaVPrint
28+
Operations whose names satisfy the above pattern(s):
3129
32-
To get more information about an operation such as juliaVPrint ,
33-
issue the command )display op juliaVPrint
30+
juliaCMPrint juliaCVPrint juliaIVPrint juliaMPrint
31+
juliaVPrint
32+
33+
To get more information about an operation such as juliaCMPrint ,
34+
issue the command )display op juliaCMPrint
3435
------------------------------- Categories --------------------------------
3536
3637
Categories with names matching patterns:
37-
julia
38+
julia
3839
3940
JARBPR JuliaArbitraryPrecision JMATCAT JuliaMatrixCategory
4041
JOBJTYP JuliaObjectType JRING JuliaRing
4142
JTYPE JuliaType JVECCAT JuliaVectorCategory
43+
JWS JuliaWolframSymbolic
4244
--------------------------------- Domains ---------------------------------
4345
4446
Domains with names matching patterns:
45-
julia
47+
julia
4648
4749
JCF64 JuliaComplexF64 JCF64MAT JuliaComplexF64Matrix
4850
JCF64SMA JuliaComplexF64SquareMatrix JCF64VEC JuliaComplexF64Vector
@@ -53,11 +55,15 @@ Domains with names matching patterns:
5355
JI64VEC JuliaInt64Vector JMATRIX JuliaMatrix
5456
JOBJECT JuliaObject JOBJTYP- JuliaObjectType&
5557
JSTR JuliaString JSYM JuliaSymbol
56-
JVECTOR JuliaVector
58+
JVECTOR JuliaVector JWS- JuliaWolframSymbolic&
59+
JWSAPR JuliaWSAPReal JWSEXPR JuliaWSExpression
60+
JWSGINT JuliaWSGaussianInteger JWSINT JuliaWSInteger
61+
JWSRAT JuliaWSRational JWSREAL JuliaWSReal
62+
JWSSYM JuliaWSSymbol
5763
-------------------------------- Packages ---------------------------------
5864
5965
Packages with names matching patterns:
60-
julia
66+
julia
6167
6268
JCF64MTF JuliaComplexF64MatrixTranscendentalFunctions
6369
JCFSF JuliaComplexFloatSpecialFunctions
@@ -75,20 +81,33 @@ System commands at this level matching patterns:
7581
julia
7682
7783
julia juliad jlapropos jldoc
84+
85+
------------------------- System Command Synonyms -------------------------
86+
87+
)ju ............................ )julia
88+
)jud ........................... )juliad
89+
7890
```
7991
Nemo Categories/Domains (JuliaObject):
92+
8093
```
8194
(1) -> )what things nemo
95+
96+
------------------------- System Command Synonyms -------------------------
97+
98+
user-defined synonyms satisfying patterns:
99+
ju
100+
82101
------------------------------- Categories --------------------------------
83102
84103
Categories with names matching patterns:
85-
nemo
104+
nemo
86105
87106
NRING NemoRing NTYPE NemoType
88107
--------------------------------- Domains ---------------------------------
89108
90109
Domains with names matching patterns:
91-
nemo
110+
nemo
92111
93112
NAN NemoAlgebraicNumber NCB NemoComplexBall
94113
NCF NemoComplexField NECF NemoExactComplexField
@@ -97,17 +116,6 @@ Domains with names matching patterns:
97116
NPF NemoPrimeField NRAT NemoRational
98117
NRB NemoRealBall NRF NemoRealField
99118
NUP NemoUnivariatePolynomial NZMOD NemoIntegerMod
100-
101-
```
102-
```
103-
------------------------- System Command Synonyms -------------------------
104-
105-
user-defined synonyms satisfying patterns:
106-
ju
107-
108-
)ju ............................ )julia
109-
)jud ........................... )juliad
110-
111119
```
112120

113121
If you want to build and locally install the HTML documentation,

0 commit comments

Comments
 (0)