Merge pull request #119 from Amin-El-Sayed/lib/symbolic-integration-maxima

Add SymbolicIntegrationMaxima subpackage

Author: ChrisRackauckas

.github/workflows/maxima.yml

@@ -0,0 +1,50 @@
+name: SymbolicIntegrationMaxima
+
+on:
+  pull_request:
+    branches:
+      - master
+      - main
+    paths:
+      - 'lib/SymbolicIntegrationMaxima/**'
+      - 'src/**'
+      - 'Project.toml'
+      - 'test/test_files/**'
+      - '.github/workflows/maxima.yml'
+  push:
+    branches:
+      - master
+      - main
+    paths:
+      - 'lib/SymbolicIntegrationMaxima/**'
+      - 'src/**'
+      - 'Project.toml'
+      - 'test/test_files/**'
+      - '.github/workflows/maxima.yml'
+
+jobs:
+  test:
+    name: Julia ${{ matrix.version }} - ${{ matrix.group }} - ubuntu-latest
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - '1.10'
+          - '1'
+        group:
+          - basic
+          - difficult
+    steps:
+      - uses: actions/checkout@v6
+      - uses: julia-actions/setup-julia@v3
+        with:
+          version: ${{ matrix.version }}
+      - name: Install Maxima
+        run: sudo apt-get update && sudo apt-get install -y maxima
+      - uses: julia-actions/cache@v3
+      - name: Run SymbolicIntegrationMaxima tests
+        env:
+          TEST_GROUP: ${{ matrix.group }}
+          MAXIMA_DIFFICULT_LIMIT: '25'
+        run: julia --project=lib/SymbolicIntegrationMaxima -e 'using Pkg; Pkg.test()'

README.md

@@ -64,18 +64,22 @@ More info about them in the [methods documentation](https://docs.sciml.ai/Symbol
 
 ### Optional external methods
 
-Additional integration methods can be provided by external packages. For example,
-[SymbolicIntegrationMaxima.jl](https://github.com/Amin-El-Sayed/SymbolicIntegrationMaxima.jl)
+Additional integration methods can be provided by optional packages. For example,
+the [`SymbolicIntegrationMaxima.jl`](https://github.com/JuliaSymbolics/SymbolicIntegration.jl/tree/main/lib/SymbolicIntegrationMaxima) subpackage
 adds a `MaximaMethod` backend that delegates to a local Maxima installation:
 
 ```julia
 using SymbolicIntegration, Symbolics, SymbolicIntegrationMaxima
 
-@variables x
+@variables x a n
 integrate(exp(-x^2), x, MaximaMethod())
+integrate(exp(-a * x), x, 0, Inf, MaximaMethod(); assumptions=(a > 0,))
+integrate(x^n * log(a * x), x, MaximaMethod();
+          assumptions=(a > 0, maxima_notequal(n, -1)))
 ```
 
-The Maxima backend is optional and is not loaded by SymbolicIntegration.jl itself.
+The Maxima backend is optional, requires a local Maxima installation, and is not
+loaded by SymbolicIntegration.jl itself.
 
 ### Risch Method
 Complete symbolic integration using the Risch algorithm from Manuel Bronstein's "Symbolic Integration I: Transcendental Functions".
@@ -103,4 +107,3 @@ If you use SymbolicIntegration.jl in your research, please cite:
   year = {2023-2025}
 }
 ```
-

docs/src/index.md

@@ -62,18 +62,22 @@ multiple symbols | ❌ | ✅
 
 ### Optional external methods
 
-External packages can provide additional integration methods. For example,
-[SymbolicIntegrationMaxima.jl](https://github.com/Amin-El-Sayed/SymbolicIntegrationMaxima.jl)
+Optional packages can provide additional integration methods. For example,
+the [`SymbolicIntegrationMaxima.jl`](https://github.com/JuliaSymbolics/SymbolicIntegration.jl/tree/main/lib/SymbolicIntegrationMaxima) subpackage
 adds a `MaximaMethod` backend that delegates integration to a local Maxima installation.
 
 ```julia
 using SymbolicIntegration, Symbolics, SymbolicIntegrationMaxima
 
-@variables x
+@variables x a n
 integrate(exp(-x^2), x, MaximaMethod())
+integrate(exp(-a * x), x, 0, Inf, MaximaMethod(); assumptions=(a > 0,))
+integrate(x^n * log(a * x), x, MaximaMethod();
+          assumptions=(a > 0, maxima_notequal(n, -1)))
 ```
 
-The Maxima backend is optional and is not loaded by SymbolicIntegration.jl itself.
+The Maxima backend is optional, requires a local Maxima installation, and is not
+loaded by SymbolicIntegration.jl itself.
 
 ### RuleBased
 This method uses a large number of integration rules that specify how to integrate various mathematical expressions.

docs/src/methods/overview.md

@@ -17,5 +17,7 @@ This method uses a large number of integration rules that specify how to integra
 ## Optional external methods
 
 Additional packages can extend SymbolicIntegration.jl with their own integration methods.
-[SymbolicIntegrationMaxima.jl](https://github.com/Amin-El-Sayed/SymbolicIntegrationMaxima.jl)
+The [`SymbolicIntegrationMaxima.jl`](https://github.com/JuliaSymbolics/SymbolicIntegration.jl/tree/main/lib/SymbolicIntegrationMaxima) subpackage
 provides a `MaximaMethod` backend for users who want to delegate integrals to a local Maxima installation.
+It supports indefinite and definite integrals, plus Maxima assumptions such as
+`assumptions=(a > 0, maxima_notequal(n, -1))` for parameter-dependent integrals.

lib/SymbolicIntegrationMaxima/Project.toml

@@ -0,0 +1,34 @@
+name = "SymbolicIntegrationMaxima"
+uuid = "6f8f0c92-4498-4b29-a8cc-7d11f58db8c9"
+authors = ["Amin Elsayed and contributors"]
+version = "0.1.1"
+license = "MIT"
+description = "Optional Maxima backend for SymbolicIntegration.jl"
+
+[deps]
+SymbolicIntegration = "315ce56f-eed0-411d-ab8a-2fbdf9327b51"
+SymbolicUtils = "d1185830-fcd6-423d-90d6-eec64667417b"
+Symbolics = "0c5d862f-8b57-4792-8d23-62f2024744c7"
+SpecialFunctions = "276daf66-3868-5448-9aa4-cd146d93841b"
+
+[sources]
+SymbolicIntegration = {path = "../.."}
+
+[compat]
+Elliptic = "1.0.1"
+HypergeometricFunctions = "0.3.28"
+PolyLog = "2.6.0"
+SpecialFunctions = "2"
+SymbolicIntegration = "3"
+SymbolicUtils = "4"
+Symbolics = "7"
+julia = "1.10"
+
+[extras]
+Elliptic = "b305315f-e792-5b7a-8f41-49f472929428"
+HypergeometricFunctions = "34004b35-14d8-5ef3-9330-4cdb6864b03a"
+PolyLog = "85e3b03c-9856-11eb-0374-4dc1f8670e7f"
+Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+
+[targets]
+test = ["Elliptic", "HypergeometricFunctions", "PolyLog", "Test"]