Installation Guide

Installation Guide

Here are the installation instructions for package NumerovShooting. If you have trouble installing it, please refer to our Troubleshooting page for more information.

Install Julia

First, you should install Julia. We recommend downloading it from its official website. The recommended way is to use a version manager Juliaup.

Install the latest Julia version by running this in your terminal:

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

on Unix-type systems. For Windows users, run

winget install julia -s msstore

Once installed, julia will be available via the command line interface. This will install the Juliaup installation manager, which will automatically install Julia and help keep it up to date. The command juliaup is also installed. To install different Julia versions see juliaup --help. There is a short video introduction to Juliaup made by its authors.

Please follow the detailed instructions on its website if you have to build Julia from source. Some computing centers may have Julia preinstalled. Please contact your administrator for more information in that case. Additional information can be found here: how to set up Julia on HPC systems.

If you have Homebrew installed, open Terminal.app and type

brew install julia

to install it as a formula.

If you are also using macOS and want to install it as a prebuilt binary app, type

brew install --cask julia

instead.

Which version should I pick?

You can install the current stable release or the long-term support (LTS) release.

The current stable release is the latest release of Julia. It has access to newer features, and is likely faster.
The long-term support release is an older version of Julia that has continued to receive bug and security fixes. However, it may not have the latest features or performance improvements.

Most users should install the 'Current stable release' and update their Julia version whenever a new version is released. Note that any code you write on one version of the current stable release will continue to work on all subsequent releases.

Users in restricted software environments, where enterprise IT controls software installations, may benefit from installing the long-term support release to reduce the frequency of updates.

Versions above v1.3, especially the latest stable ones, are strongly recommended. This package is highly unlikely to work on v1.0 and earlier versions. Since the Julia team has set v1.6 as the LTS release, we will gradually drop support for versions below v1.6.

Julia and Julia packages support multiple operating systems and CPU architectures; check this table to see if it can be installed on your machine. For Mac computers with M-series processors, this package and its dependencies may not work. Please install the Intel-compatible version of Julia (for macOS x86-64) if any platform-related error occurs.

Install the package

The following installation steps are demonstrated using macOS as the standard platform:

Open the Terminal app, and type julia to start an interactive session (known as the REPL).

Run the following commands and wait for them to finish:

julia> using Pkg

julia> Pkg.update()

julia> Pkg.add("NumerovShooting")

Run
```
julia> using NumerovShooting
```
and have fun!
Please keep the Julia session active while using it. Restarting the session may take some time.

If you want to install the latest in-development (probably buggy) version of NumerovShooting, type

julia> using Pkg
julia> Pkg.update()    Updating registry at `~/.julia/registries/General.toml`
  No Changes to `~/work/NumerovShooting.jl/NumerovShooting.jl/docs/Project.toml`
  No Changes to `~/work/NumerovShooting.jl/NumerovShooting.jl/docs/Manifest.toml`
julia> pkg"add https://github.com/singularitti/NumerovShooting.jl"┌ Warning: The Pkg REPL mode is intended for interactive use only, and should not be used from scripts. It is recommended to use the functional API instead.
└ @ Pkg.REPLMode /opt/hostedtoolcache/julia/1.11.3/x64/share/julia/stdlib/v1.11/Pkg/src/REPLMode/REPLMode.jl:388
     Cloning git-repo `https://github.com/singularitti/NumerovShooting.jl`
    Updating git-repo `https://github.com/singularitti/NumerovShooting.jl`
   Resolving package versions...
    Updating `~/work/NumerovShooting.jl/NumerovShooting.jl/docs/Project.toml`
  [a831be1b] ~ NumerovShooting v0.1.0 `~/work/NumerovShooting.jl/NumerovShooting.jl` ⇒ v0.1.0 `https://github.com/singularitti/NumerovShooting.jl#main`
    Updating `~/work/NumerovShooting.jl/NumerovShooting.jl/docs/Manifest.toml`
  [a831be1b] ~ NumerovShooting v0.1.0 `~/work/NumerovShooting.jl/NumerovShooting.jl` ⇒ v0.1.0 `https://github.com/singularitti/NumerovShooting.jl#main`
Precompiling project...
    707.3 ms  ✓ NumerovShooting
  1 dependency successfully precompiled in 1 seconds. 70 already precompiled.
  1 dependency precompiled but a different version is currently loaded. Restart julia to access the new version. Otherwise, loading dependents of this package may trigger further precompilation to work with the unexpected version.

in the second step above.

Update the package

Please watch our GitHub repository for new releases. Once we release a new version, you can update NumerovShooting by typing

julia> using Pkg
julia> Pkg.update("NumerovShooting")    Updating registry at `~/.julia/registries/General.toml`
    Updating git-repo `https://github.com/singularitti/NumerovShooting.jl`
  No Changes to `~/work/NumerovShooting.jl/NumerovShooting.jl/docs/Project.toml`
  No Changes to `~/work/NumerovShooting.jl/NumerovShooting.jl/docs/Manifest.toml`
julia> Pkg.gc()      Active manifest files: 3 found
      Active artifact files: 4 found
      Active scratchspaces: 0 found
     Deleted no artifacts, repos, packages or scratchspaces

in the Julia REPL.

Uninstall and then reinstall the package

Errors may occur if the package is improperly installed. In this case, you may want to uninstall and reinstall the package. Here is how to do that:

To uninstall, in a Julia session, run

julia> using Pkg

julia> Pkg.rm("NumerovShooting")

julia> Pkg.gc()

Press Ctrl+D to quit the current session. Start a new Julia session and reinstall NumerovShooting.