Skip to content

Commit dd2b59e

Browse files
committed
LanguageTool
1 parent 3a92b74 commit dd2b59e

File tree

2 files changed

+27
-2
lines changed

2 files changed

+27
-2
lines changed

docs/src/index.md

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,20 @@
22

33
**SymbolicNumericIntegration.jl** is a hybrid symbolic/numerical integration package that works on the [Julia Symbolics](https://docs.sciml.ai/Symbolics/stable/) expressions.
44

5-
**SymbolicNumericIntegration.jl** uses a randomized algorithm based on a hybrid of the *method of undetermined coefficients* and *sparse regression* and is able to solve a large subset of basic standard integrals (polynomials, exponential/logarithmic, trigonometric and hyperbolic, inverse trigonometric and hyperbolic, rational and square root).
5+
**SymbolicNumericIntegration.jl** uses a randomized algorithm based on a hybrid of the *method of undetermined coefficients* and *sparse regression* and can solve a large subset of basic standard integrals (polynomials, exponential/logarithmic, trigonometric and hyperbolic, inverse trigonometric and hyperbolic, rational and square root).
66
The basis of how it works and the theory of integration using the Symbolic-Numeric methods refer to [Basis of Symbolic-Numeric Integration](https://github.com/SciML/SymbolicNumericIntegration.jl/blob/main/docs/theory.ipynb).
77

88
Function `integrate` returns the integral of a univariate expression with *constant* real or complex coefficients. `integrate` returns a tuple with three values. The first one is the solved integral, the second one is the sum of the unsolved terms, and the third value is the residual error. If `integrate` is successful, the unsolved portion is reported as 0.
99

10+
## Installation
11+
12+
To install SymbolicNumericIntegration.jl, use the Julia package manager:
13+
14+
```julia
15+
using Pkg
16+
Pkg.add("SymbolicNumericIntegration")
17+
```
18+
1019
```julia
1120
using Symbolics
1221
using SymbolicNumericIntegration
@@ -122,6 +131,22 @@ If you use **SymbolicNumericIntegration.jl**, please cite [Symbolic-Numeric Inte
122131
}
123132
```
124133

134+
## Contributing
135+
136+
- Please refer to the
137+
[SciML ColPrac: Contributor's Guide on Collaborative Practices for Community Packages](https://github.com/SciML/ColPrac/blob/master/README.md)
138+
for guidance on PRs, issues, and other matters relating to contributing to SciML.
139+
140+
- See the [SciML Style Guide](https://github.com/SciML/SciMLStyle) for common coding practices and other style decisions.
141+
- There are a few community forums:
142+
143+
+ The #diffeq-bridged and #sciml-bridged channels in the
144+
[Julia Slack](https://julialang.org/slack/)
145+
+ The #diffeq-bridged and #sciml-bridged channels in the
146+
[Julia Zulip](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged)
147+
+ On the [Julia Discourse forums](https://discourse.julialang.org)
148+
+ See also [SciML Community page](https://sciml.ai/community/)
149+
125150
## Reproducibility
126151

127152
```@raw html

src/integral.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ Base.signbit(x::SymbolicUtils.Sym{Number, Nothing}) = false
2323
max_basis: the maximum number of candidate terms to consider
2424
verbose: print a detailed report
2525
complex_plane: generate random test points on the complex plane (if false, the points will be on real axis)
26-
homotomy: use the homotopy algorithm to generat the basis
26+
homotopy: use the homotopy algorithm to generate the basis
2727
2828
output:
2929
-------

0 commit comments

Comments
 (0)