Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Some README updates #153

Merged
merged 1 commit into from
Nov 13, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 23 additions & 21 deletions JuliaExperimental/README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,29 @@
# The GAP 4 package `JuliaExperimental'

JuliaExperimental provides experimental code to test and explore the capabilities of the JuliaInterface package, and the general combination of GAP and Julia.
JuliaExperimental provides experimental code to test and explore the
capabilities of the JuliaInterface package, and the general combination of
GAP and Julia.

## General Disclaimer

##
All code in this repository is preliminary work.

It comes with absolutely no warranty and will most likely have errors. If you use it for computations, please check the correctness of the result very carefully.
It comes with absolutely no warranty and will most likely have errors. If you
use it for computations, please check the correctness of the result very
carefully.

Also, everything in this repository might change in the future, so currently any update can break the code you wrote upon functionality from packages in this repository.
Also, everything in this repository might change in the future, so currently
any update can break the code you wrote upon functionality from packages in
this repository.

This software is licensed under the LGPL, version 3, or any later version.

## Installation

### Requirements

- Julia 0.6.2 or higher, compiled in `<path_to_julia>`
- GAP 4.9.1 or higher, compiled in `<path_to_gaproot>`
- Julia 1.1 or higher, compiled in `<path_to_julia>`
- GAP 4.11 or higher, compiled in `<path_to_gaproot>`
- JuliaInterface, compiled in `<path_to_juliainterface>`
- The Julia packages Nemo.jl and Singular.jl

Expand All @@ -27,31 +33,27 @@ This software is licensed under the LGPL, version 3, or any later version.

- Compile the JuliaInterface package as described it its README.md
- Start Julia and make sure Nemo.jl and Singular.jl are compiled, by typing
```
using Singular
using Nemo
```

using Singular
using Nemo

- Configure and compile JuliaExperimental via
```
cd <path_to_juliainterface>/../JuliaExperimental
./autogen.sh
./configure --with-gaproot=<path_to_gaproot> --with-julia=<path_to_julia>/usr --with-juliainterface=<path_to_juliainterface>
make
```

cd <path_to_juliainterface>/../JuliaExperimental
./autogen.sh
./configure --with-gaproot=<path_to_gaproot> --with-julia=<path_to_julia>/usr --with-juliainterface=<path_to_juliainterface>
make

#### Notes for Mac OS X

It is possible to link JuliaExperimental against the official Julia binary
which one can download from <https://julialang.org/downloads/>.
To do so, run configure as follows:

./configure --with-julia=/PATH/TO/Julia*.app/Contents/Resources/julia
./configure --with-julia=/PATH/TO/Julia*.app/Contents/Resources/julia

## Usage

Load the JuliaExperimental package via
```
LoadPackage( "JuliaExperimental" );
```


LoadPackage( "JuliaExperimental" );
14 changes: 6 additions & 8 deletions LibGAP.jl/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
OSCAR - LibGAP
--------------

This is some prototype code that uses a version of GAP as a library,
as found the GAP master branch, respectively in GAP 4.11,
to be able to call GAP functions from Julia.
This is some prototype code that uses a version of GAP as a library, as found
the GAP master branch, respectively in GAP 4.11 (to be released in 2019), to
be able to call GAP functions from Julia.

Please don't use for any production code just yet, but do use it for
prototyping and let me know what's wrong with it.
prototyping and let us know about any issues with it you encounter.

How to use
----------
Expand All @@ -21,17 +21,15 @@ You need the following ingredients:
(if you did not install Julia but built it in director `$juliasrc`, then set
`$juliadir` to `$juliasrc/usr`)

- The `GAPJulia` repository, checked out under `$oscarrepo`
- The `GAPJulia` repository, checked out under `$oscardir`

First we compile a version of GAP using the Julia installation in `$juliadir`,
and make sure a `libgap` shared library is compiled:
First compile a version of GAP using the Julia installation in `$juliadir`:

cd $oscardir
mkdir -p gap
cd gap
$gapdir/configure --with-gc=julia --with-julia=$juliadir
make
make libgap.la

Now we can compile JuliaInterface and JuliaExperimental:

Expand Down
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,12 @@

# GAPJulia Meta-package

This repository contains the GAP packages developed for the GAP-Julia integration as part of the
This repository contains the GAP and Julia packages developed for the GAP-Julia integration as part of the
[OSCAR project](http://oscar.computeralgebra.de).

It currently consist of the packages
* JuliaInterface
* JuliaExperimental
It currently consist of the GAP packages `JuliaInterface` and `JuliaExperimental`, as well as the Julia package `LibGAP.jl`.

For a description of the packages and how to install them see the specific README.md files in the respective folders.
For a description of the packages and how to install them see the specific `README.md` files in the respective folders.

## General Disclaimer

Expand Down