Skip to content

Commit

Permalink
Revert "Rework OSCAR loading (#151)"
Browse files Browse the repository at this point in the history
  • Loading branch information
lgoettgens committed Jun 11, 2024
1 parent 56e9d58 commit d8c007d
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 43 deletions.
29 changes: 6 additions & 23 deletions .github/workflows/Documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -20,29 +20,12 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- name: "Set up Julia"
uses: julia-actions/setup-julia@latest
- uses: julia-actions/setup-julia@v2
with:
version: '1.10'

- name: Restore cache
uses: julia-actions/cache@v1
with:
cache-name: 'docs-1.10'

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

- name: Build and deploy
- uses: julia-actions/cache@v1
- uses: julia-actions/julia-buildpkg@v1
- uses: julia-actions/julia-docdeploy@v1
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
run: julia --project=docs/ --color=yes docs/make.jl
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
5 changes: 3 additions & 2 deletions .github/workflows/OscarTests.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,10 +64,11 @@ jobs:
cache-name: julia-cache;workflow=${{ github.workflow }};julia=${{ matrix.julia-version }};arch=${{ runner.arch }}
include-matrix: false

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

Expand Down
9 changes: 2 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,11 @@

## Install

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

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: 2 additions & 7 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,11 @@ 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
o install this package in Julia, clone it from github and then run the following command in the Julia REPL from the package directory:
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:
```
using Pkg
Pkg.activate(".")
include(joinpath(pwd(), "etc", "add_oscar.jl"))
using PBWDeformations, Oscar
] add PBWDeformations
```

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
1 change: 0 additions & 1 deletion etc/OSCAR.rev

This file was deleted.

3 changes: 0 additions & 3 deletions etc/add_oscar.jl

This file was deleted.

0 comments on commit d8c007d

Please sign in to comment.