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

Rework OSCAR loading #151

Merged
merged 2 commits into from
Feb 22, 2024
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
17 changes: 4 additions & 13 deletions .github/workflows/Documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,24 +31,15 @@ jobs:
with:
cache-name: 'docs-1.10'

- name: "Dev Oscar.jl master"
shell: julia --project=. --color=yes {0}
run: |
using Pkg
Pkg.add(url="https://github.com/lgoettgens/Oscar.jl", rev="master-pbwdeformations")
env:
JULIA_PKG_PRECOMPILE_AUTO: no

- name: Build package
uses: julia-actions/julia-buildpkg@latest

- name: Install dependencies
- name: "Instantiate deps (including Oscar.jl master)"
shell: julia --project=docs/ --color=yes {0}
run: |
using Pkg
Pkg.add(url="https://github.com/lgoettgens/Oscar.jl", rev="master-pbwdeformations")
include(joinpath(pwd(), "etc", "add_oscar.jl"))
Pkg.develop(PackageSpec(path=pwd()))
Pkg.instantiate()
env:
JULIA_PKG_PRECOMPILE_AUTO: no

- name: Build and deploy
env:
Expand Down
7 changes: 3 additions & 4 deletions .github/workflows/OscarTests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ concurrency:
jobs:
oscartest:
runs-on: ${{ matrix.os }}
timeout-minutes: 120
timeout-minutes: 30
continue-on-error: ${{ matrix.julia-version == 'nightly' }}
strategy:
fail-fast: false
Expand Down Expand Up @@ -66,11 +66,10 @@ jobs:
cache-name: julia-cache;workflow=${{ github.workflow }};julia=${{ matrix.julia-version }};arch=${{ runner.arch }}
include-matrix: false

- name: "Dev Oscar.jl master"
- name: "Add deps (including Oscar.jl master)"
shell: julia --project=. --color=yes {0}
run: |
using Pkg
Pkg.add(url="https://github.com/lgoettgens/Oscar.jl", rev="master-pbwdeformations")
include(joinpath(pwd(), "etc", "add_oscar.jl"))
env:
JULIA_PKG_PRECOMPILE_AUTO: no

Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/Tests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ concurrency:
jobs:
test:
runs-on: ${{ matrix.os }}
timeout-minutes: 120
timeout-minutes: 30
continue-on-error: ${{ matrix.julia-version == 'nightly' }}
strategy:
fail-fast: false
Expand Down
1 change: 1 addition & 0 deletions OSCAR.rev
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
13c3fc3c202f6a694efb849a39b625fa383feb46
9 changes: 7 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,16 @@

## Install

To install this package in Julia:
To install this package in Julia, clone it from github and then run the following command in the Julia REPL from the package directory:
```
using Pkg; Pkg.add("PBWDeformations")
using Pkg
Pkg.activate(".")
include(joinpath(pwd(), "etc", "add_oscar.jl"))
using PBWDeformations, Oscar
```

This package depends on a development version of the [Oscar](https://oscar.computeralgebra.de/) package. The `add_oscar.jl` script will add the Oscar package to the current environment. If you want to use the package in a different environment, you can run the `add_oscar.jl` script int the other environment to obtain the specific version of Oscar.

## Functionality

The package will provide both a general framework and specialized functions in order to
Expand Down
9 changes: 7 additions & 2 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,16 @@ To solve classification problems efficiently, we use representation theoretic id
- For some modules of ``\mathfrak{so}_n``, give an explicit basis using arc diagrams or pseudographs (cf. [FM22](@cite)).

## Installation
As this package heavily relies on [Oscar](https://oscar.computeralgebra.de/), it is recommended to install Oscar first ([installation instructions](https://oscar.computeralgebra.de/install/)). Then, install this package via the Julia package manager:
o install this package in Julia, clone it from github and then run the following command in the Julia REPL from the package directory:
```
] add PBWDeformations
using Pkg
Pkg.activate(".")
include(joinpath(pwd(), "etc", "add_oscar.jl"))
using PBWDeformations, Oscar
```

This package depends on a development version of the [Oscar](https://oscar.computeralgebra.de/) package. The `add_oscar.jl` script will add the Oscar package to the current environment. If you want to use the package in a different environment, you can run the `add_oscar.jl` script int the other environment to obtain the specific version of Oscar.

## Outline
```@contents
Pages = [
Expand Down
3 changes: 3 additions & 0 deletions etc/add_oscar.jl
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
using Pkg
rev = readline("OSCAR.rev")
Pkg.add(PackageSpec(; url="https://github.com/oscar-system/Oscar.jl", rev))
Loading