Home

These are some personal notes on the development workflow of OSCAR. See also the official documentation.

Setting up development environment

git clone https://github.com/oscar-system/Oscar.jl

Then change directory to Oscar.jl, start julia and type

julia> ]
(@v1.9) pkg> dev .

Then you can start using OSCAR. Updating the code proceeds in two steps.

git pull

and then

julia> ]
(@v1.9) pkg> up

Testing experimental module

julia> Oscar.test_experimental_module("ComplexReflectionGroups")

Building documentation

Build the OSCAR documentation with

julia> build_doc(;open_browser=false)

If you added references to docs/oscar_references.bib then run

$ bibtool docs/oscar_references.bib -o docs/oscar_references.bib

from the OSCAR root directory.

Sync a local copy of the documentation via

$ rsync -a SERVER:/home/thiel/Oscar.jl/docs/build/ /Users/thiel/Tmp/Oscar-Doc

Shell alias for OSCAR

You can define a shell alias for OSCAR (to put in your BASH profile for example) as follows:

alias oscar="julia -e 'using Oscar;' -i"