Skip to content

Commit

Permalink
[GALAHAD.jl] Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
amontoison committed Jul 9, 2024
1 parent 98d9c6d commit fee722a
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 26 deletions.
4 changes: 1 addition & 3 deletions .github/workflows/julia.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
name: GALAHAD.jl

on:
push:
branches:
- main

jobs:
test:
name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
Expand Down Expand Up @@ -34,7 +32,7 @@ jobs:
version: ${{ matrix.version }}
arch: ${{ matrix.arch }}

- name: Test GALAHAD.jl on push
- name: Test GALAHAD.jl
if: github.event_name == 'push' && contains(github.event.head_commit.message, '[GALAHAD.jl]')
shell: bash
run: |
Expand Down
28 changes: 5 additions & 23 deletions GALAHAD.jl/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,4 @@
# A [Julia](http://julialang.org) Interface to [GALAHAD](https://www.galahad.rl.ac.uk/)

| **Documentation** | **Linux/macOS/Windows/FreeBSD** | **Coverage** |
|:-----------------:|:-------------------------------:|:------------:|
| [![docs-stable][docs-stable-img]][docs-stable-url] [![docs-dev][docs-dev-img]][docs-dev-url] | [![build-gh][build-gh-img]][build-gh-url] [![build-cirrus][build-cirrus-img]][build-cirrus-url] | [![codecov][codecov-img]][codecov-url] |

[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
[docs-stable-url]: https://amontoison.github.io/GALAHAD.jl/stable
[docs-dev-img]: https://img.shields.io/badge/docs-dev-purple.svg
[docs-dev-url]: https://amontoison.github.io/GALAHAD.jl/dev
[build-gh-img]: https://github.com/amontoison/GALAHAD.jl/workflows/CI/badge.svg?branch=main
[build-gh-url]: https://github.com/amontoison/GALAHAD.jl/actions
[build-cirrus-img]: https://img.shields.io/cirrus/github/amontoison/GALAHAD.jl?logo=Cirrus%20CI
[build-cirrus-url]: https://cirrus-ci.com/github/amontoison/GALAHAD.jl
[codecov-img]: https://codecov.io/gh/amontoison/GALAHAD.jl/branch/main/graph/badge.svg
[codecov-url]: https://app.codecov.io/gh/amontoison/GALAHAD.jl
# A [Julia](http://julialang.org) interface to [GALAHAD](https://www.galahad.rl.ac.uk/)

## Installation

Expand All @@ -30,16 +15,14 @@ directly run `pkg> dev .`.

## Custom shared libraries

GALAHAD is already precompiled with
[Yggdrasil](https://github.com/JuliaPackaging/Yggdrasil) for all
platforms. The Julia package
[GALAHAD_jll.jl](https://github.com/JuliaBinaryWrappers/GALAHAD_jll.jl)
GALAHAD is already precompiled with [Yggdrasil](https://github.com/JuliaPackaging/Yggdrasil) for all platforms.
The Julia package [GALAHAD_jll.jl](https://github.com/JuliaBinaryWrappers/GALAHAD_jll.jl)
is a dependency of GALAHAD.jl and handles the automatic download of a
precompiled version of GALAHAD for you.

To facilitate testing of new features by GALAHAD developers or enable
advanced users to utilize commercial linear solvers like PARDISO or
WSMP, it is also possible to bypass reliance on precompiled shared
advanced users to utilize commercial linear solvers like `PARDISO` or
`WSMP`, it is also possible to bypass reliance on precompiled shared
libraries.

To use your own installation of `GALAHAD`, set the environment variable
Expand All @@ -58,4 +41,3 @@ permanently in the shell's startup file, or in
## Documentation

Documentation is available online from [https://ralna.github.io/galahad_docs/html/Julia](https://ralna.github.io/galahad_docs/html/Julia).

0 comments on commit fee722a

Please sign in to comment.