# BSeries.jl

BSeries.jl is a collection of functionality around B-series in Julia. See for example

- Philippe Chartier, Ernst Hairer, Gilles Vilmart (2010) Algebraic Structures of B-series. Foundations of Computational Mathematics DOI: 10.1007/s10208-010-9065-1

BSeries.jl re-exports everything from RootedTrees.jl. However, if you rely on functionality from that package, you should also include it explicitly in your project dependencies to track breaking changes, since the version numbers of RootedTrees.jl and BSeries.jl are not necessarily synchronized.

The main API of BSeries.jl consists of the following components.

- B-series behave like
`AbstractDict`

s mapping (abstract)`RootedTree`

s to coefficients. - The B-series of time integration methods such as Runge-Kutta methods can be constructed by the function
`bseries`

. - Vector space operations (addition/subtraction and multiplication by scalars) are available.
- The algebraic structures of the composition law and the substitution law are implemented via
`compose`

and`substitute`

. - Backward error analysis can be performed via
`modified_equation`

s and`modifying_integrator`

s.

Further information is provided in the following tutorials and API documentation.

Please note that B-series analysis is most conveniently applied to the autonomous form of ordinary differential equations (ODEs). Thus, BSeries.jl and RootedTrees.jl usually assume that time integration methods give the same result, independent of whether an ODE is written in an autonomous or a non-autonomous form. For Runge-Kutta methods, this means that the usual row-sum assumption is used.

## Installation

BSeries.jl is a registered Julia package. Thus, you can install it from the Julia REPL via

`julia> using Pkg; Pkg.add("BSeries")`

BSeries.jl works with Julia version 1.6 and newer.

If you want to update BSeries.jl, you can use

`julia> using Pkg; Pkg.update("BSeries")`

As usual, if you want to update BSeries.jl and all other packages in your current project, you can execute

`julia> using Pkg; Pkg.update()`

## Referencing

If you use BSeries.jl for your research, please cite it using the bibtex entry

```
@article{ketcheson2023computing,
title={Computing with {B}-series},
author={Ketcheson, David I and Ranocha, Hendrik},
journal={ACM Transactions on Mathematical Software},
volume={49},
number={2},
year={2023},
month={06},
doi={10.1145/3573384},
eprint={2111.11680},
eprinttype={arXiv},
eprintclass={math.NA}
}
```

In addition, you can also refer to BSeries.jl directly as

```
@misc{ranocha2021bseries,
title={{BSeries.jl}: {C}omputing with {B}-series in {J}ulia},
author={Ranocha, Hendrik and Ketcheson, David I},
year={2021},
month={09},
howpublished={\url{https://github.com/ranocha/BSeries.jl}},
doi={10.5281/zenodo.5534602}
}
```

Please also cite the appropriate references for specific functions you use, which can be obtained from their docstrings.

## License and contributing

This project is licensed under the MIT license (see License). Since it is an open-source project, we are very happy to accept contributions from the community. Please refer to the section Contributing for more details.