Skip to content

install-mac.md

Latest commit

 

History

History
94 lines (67 loc) · 4.43 KB

install-mac.md

File metadata and controls

94 lines (67 loc) · 4.43 KB
layout page
Mac Windows Linux Other

Installing OSCAR {{ site.data.release.version }} on MacOS

🛠️ Already have OSCAR installed? [Upgrade to the latest version here.]({{ site.baseurl }}/upgrade/)

To install OSCAR v{{ site.data.release.version }}, the latest stable release, follow the steps below.

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 RAM.

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

Having trouble? You can visit our Contact & Support page to get in touch — or check out the Frequently Asked Questions for quick tips and troubleshooting guidance.

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.

  1. Launch a Terminal and copy and paste the command xcode-select --install, then press enter.
  2. 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.
  3. Wait for this to complete; it needs to download about 130 MB of data.
  4. 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

OSCAR requires Julia 1.6.0 or higher. We recommend using the latest stable release of Julia as follows:

curl -fsSL https://install.julialang.org | sh

Step 3: Install OSCAR

  1. Open the Julia REPL in your terminal. 
    julia
  2. Install OSCAR by running the following commands. This may take a while to complete, as it will download and install OSCAR and its dependencies. 
    using Pkg
Pkg.add("Oscar")

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 and extending ANTIC, GAP,
| |_| |\__ \| |__  / ^ \ |  ´ /  | Polymake and Singular
 \___/ \___/ \___//_/ \_\|_|\_\  | Type "?Oscar" for more information
o--------o-----o-----o--------o  | Documentation: https://docs.oscar-system.org
  S Y M B O L I C   T O O L S    | Version 1.4.0

Step 5: Running Tutorials Locally with IJulia

  1. 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. 2. Download the tutorial of your interested from the [list of available OSCAR tutorials]({{site.baseurl }}/tutorials). 3. Start Jupyter by running the following in your Julia REPL:

using IJulia; notebook()
  1. 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.
⚡