From 828ddc76f67a1c45b51e39eddd14d67dcfcc57fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lars=20G=C3=B6ttgens?= Date: Thu, 22 Feb 2024 14:18:21 +0100 Subject: [PATCH 1/2] Rework OSCAR loading --- .github/workflows/Documentation.yml | 17 ++++------------- .github/workflows/OscarTests.yml | 7 +++---- .github/workflows/Tests.yml | 2 +- OSCAR.rev | 1 + etc/add_oscar.jl | 3 +++ 5 files changed, 12 insertions(+), 18 deletions(-) create mode 100644 OSCAR.rev create mode 100644 etc/add_oscar.jl diff --git a/.github/workflows/Documentation.yml b/.github/workflows/Documentation.yml index affc6b4..ea7ed86 100644 --- a/.github/workflows/Documentation.yml +++ b/.github/workflows/Documentation.yml @@ -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: diff --git a/.github/workflows/OscarTests.yml b/.github/workflows/OscarTests.yml index a5a3ede..eb490dc 100644 --- a/.github/workflows/OscarTests.yml +++ b/.github/workflows/OscarTests.yml @@ -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 @@ -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 diff --git a/.github/workflows/Tests.yml b/.github/workflows/Tests.yml index 94db1be..87dc157 100644 --- a/.github/workflows/Tests.yml +++ b/.github/workflows/Tests.yml @@ -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 diff --git a/OSCAR.rev b/OSCAR.rev new file mode 100644 index 0000000..9dff057 --- /dev/null +++ b/OSCAR.rev @@ -0,0 +1 @@ +13c3fc3c202f6a694efb849a39b625fa383feb46 diff --git a/etc/add_oscar.jl b/etc/add_oscar.jl new file mode 100644 index 0000000..febb16b --- /dev/null +++ b/etc/add_oscar.jl @@ -0,0 +1,3 @@ +using Pkg +rev = readline("OSCAR.rev") +Pkg.add(PackageSpec(; url="https://github.com/oscar-system/Oscar.jl", rev)) From 9124ac4ac22d17945a95f93d76f94d9085626044 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lars=20G=C3=B6ttgens?= Date: Thu, 22 Feb 2024 14:40:35 +0100 Subject: [PATCH 2/2] Adapt installation guide --- README.md | 9 +++++++-- docs/src/index.md | 9 +++++++-- 2 files changed, 14 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index aa55eeb..ebca08b 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/src/index.md b/docs/src/index.md index 87bcba7..a51ec70 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -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 = [