Mac Windows Linux Other

Installing OSCAR 1.3.1 on MacOS

You are about to install OSCAR v1.3.1, the latest stable release. Follow the instructions below to set up OSCAR on your system.

WARNING: The installation process of OSCAR, particularly the precompilation step, requires at least 6GB of free memory. For optimal performance with OSCAR, we recommend having at least 16GB of free memory.

The following instructions assume that you are at least somewhat familiar with using a terminal interface.

Having trouble? Visit our Contact & Support page to get in touch.

Step 1: Install prerequisites

If you are using macOS 10.12 or newer, you need to install the Xcode command line tools, as explained in the following instructions.

Launch a Terminal and copy and paste the command xcode-select --install, then press enter.
A window will appear asking you: The xcode-select command requires the command line developer tools. Would you like to install the tools now?. Confirm this by clicking Install.
Wait for this to complete; it needs to download about 130 MB of data.
You can verify that everything worked by verifying that the folder /Library/Developer/CommandLineTools/usr/bin/ exists and contains executables such as clang and clang++, the C and C++ compiler.

Step 2: Install Julia

WARNING: macOS users should generally not install the Julia version provided by their package manager (e.g., `apt`, `pac`, `dnf`, `homebrew`, ...), as in many cases, these Julia version are either outdated, or crippled, or both.

OSCAR requires Julia 1.6.0 or higher. We recommend using the latest stable release of Julia.
We suggest installing Julia via juliaup for easy updates and version management. juliaup will automatically install the latest stable release of Julia and allows you to manage multiple Julia versions if needed.
To install Julia via juliaup, run the following command in your terminal:
```
curl -fsSL https://install.julialang.org | sh
```
Alternatively, you can download Julia directly from the official website and follow the installation instructions for macOS.

Step 3: Install OSCAR

Open the Julia REPL in your terminal.
Install OSCAR by running the following commands:
```
using Pkg
Pkg.add("Oscar")
```
This process will take a few minutes to complete, as it will install OSCAR and its dependencies. Internet access is required.

Step 4: Start OSCAR

After the installation is complete, you can start using OSCAR by running using Oscar in the Julia REPL:

julia> using Oscar
  ___   ____   ____    _    ____
 / _ \ / ___| / ___|  / \  |  _ \   |  Combining ANTIC, GAP, Polymake, Singular
| | | |\___ \| |     / _ \ | |_) |  |  Type "?Oscar" for more information
| |_| | ___) | |___ / ___ \|  _ <   |  Manual: https://docs.oscar-system.org
 \___/ |____/ \____/_/   \_\_| \_\  |  Version 1.0.0

Step 5: Running Tutorials Locally with IJulia

Install IJulia (and jupyter) by running the following command inside your Julia REPL:
```
using Pkg; Pkg.add("IJulia")
```
For more details, refer to the installation guide. If you encounter issues, you may need to explicitly build IJulia. Troubleshooting info can be found on the IJulia troubleshooting page.
Download the tutorial of your interested from the list of available OSCAR tutorials.
Start Jupyter by running the following in your Julia REPL:
```
using IJulia; notebook()
```
Your web browser should open with the Jupyter interface, where “Jupyter” is displayed in the upper-left corner, and a file explorer appears below. Locate and open the tutorial notebook of your interest.
You might see a pop-up with the message “Kernel not found” or “Kernel error”. You can resolve this by selecting a different Julia kernel from the notebook’s kernel menu.