From e8a25b5f45cfa00da1ece5a9838255ab90a2d4b6 Mon Sep 17 00:00:00 2001 From: Skylar Gering Date: Sun, 30 Nov 2025 16:37:20 -0500 Subject: [PATCH 1/3] update readme for registration --- Project.toml | 4 ++-- README.md | 26 ++++++++------------------ 2 files changed, 10 insertions(+), 20 deletions(-) diff --git a/Project.toml b/Project.toml index 4d52ff3..fffe027 100644 --- a/Project.toml +++ b/Project.toml @@ -34,7 +34,7 @@ CairoMakie = "0.12, 0.13" CoordinateTransformations = "0.6" Extents = "0.1" GeoInterfaceMakie = "0.1" -GeometryOps = "0.1.31" +GeometryOps = "0.1.31 - 0.1" Interpolations = "0.14, 0.15, 0.16" JLD2 = "0.4, 0.5, 0.6" Measures = "0.3" @@ -44,7 +44,7 @@ SplitApplyCombine = "1" StaticArrays = "1" Statistics = "1" StructArrays = "0.6, 0.7" -julia = "1.9" +julia = "1.10" [extras] LibGEOS = "a90b1aa1-3769-5649-ba7e-abc5a9d163eb" diff --git a/README.md b/README.md index 5026818..e992cee 100644 --- a/README.md +++ b/README.md @@ -21,31 +21,21 @@ To learn how to build and run simulations, [check out our documentation and tuto ## _Installation_ -Subzero is not yet a [registered Julia package](https://julialang.org/packages/). So to install it, +Subzero is a [registered Julia package](https://julialang.org/packages/). So to install it, 1. [Download Julia](https://julialang.org/downloads/) (version 1.9 or later). We recommend using [`JuliaUp`](https://github.com/JuliaLang/juliaup) so it is easy to change versions in the future. -2. As `Subzero.jl` is not yet registered as an official package, you will need to install it from GitHub. To do this, you will need a SSH key on your computer and stored in GitHub. GitHub provides documentation for the needed steps: - - [Checking for existing SSH keys](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys) - - [Generating a new key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) - - [Adding a new key](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account) - - [Testing your connection](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/testing-your-ssh-connection). +2. Launch Julia and type -3. Once you have established your SSH connection from within terminal, you now need to update your Julia `startup.jl` file. This is within the `.julia/config` folder. If you don't have a `.config` folder, please make one using `mkdir config` run on terminal within your `.julia` folder. If you don't have a `startup.jl` file you can make this using `touch startup.jl` within the `config` folder. Then, using a text editor (such as vim), add the following line to your `startup.jl` file: +```julia +julia> using Pkg - `ENV["JULIA_PKG_USE_CLI_GIT"]=true` +julia> Pkg.add("Subzero") +``` - We need this as Julia's SSH library can't read the types of SSH keys that GitHub now requires. This will have Julia use your local command line interface (CLI) version of Git. This only works with Julia 1.7 and higher. +This installs the latest version that's _compatible with your current environment_. -4. Launch Julia and enter into the package manager mode by typing `]` in the terminal. - -5. Run the following - - ```julia - pkg> add "git@github.com:Caltech-OCTO/Subzero.jl.git" - ``` - - This will add the package to your package manager. After that you return to the REPL mode by hitting the backspace and you are ready to use Subzero! +3. You are ready to use Subzero! Get started with: ```julia julia> using Subzero From 4020f2529c7691e2418802d37442fd35b4a1660a Mon Sep 17 00:00:00 2001 From: Skylar Gering Date: Sun, 30 Nov 2025 16:40:33 -0500 Subject: [PATCH 2/3] clean up readme --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e992cee..cc7d0e4 100644 --- a/README.md +++ b/README.md @@ -23,15 +23,15 @@ To learn how to build and run simulations, [check out our documentation and tuto Subzero is a [registered Julia package](https://julialang.org/packages/). So to install it, -1. [Download Julia](https://julialang.org/downloads/) (version 1.9 or later). We recommend using [`JuliaUp`](https://github.com/JuliaLang/juliaup) so it is easy to change versions in the future. +1. [Download Julia](https://julialang.org/downloads/) (version 1.10 or later). We recommend using [`JuliaUp`](https://github.com/JuliaLang/juliaup) so it is easy to change versions in the future. 2. Launch Julia and type -```julia -julia> using Pkg + ```julia + julia> using Pkg -julia> Pkg.add("Subzero") -``` + julia> Pkg.add("Subzero") + ``` This installs the latest version that's _compatible with your current environment_. From d5bc38a0c17f6ba997bf1e8cf6c44015a073417c Mon Sep 17 00:00:00 2001 From: Skylar Gering Date: Sun, 30 Nov 2025 16:41:11 -0500 Subject: [PATCH 3/3] fix readme spacing --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index cc7d0e4..30a0556 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ Subzero is a [registered Julia package](https://julialang.org/packages/). So to julia> Pkg.add("Subzero") ``` -This installs the latest version that's _compatible with your current environment_. + This installs the latest version that's _compatible with your current environment_. 3. You are ready to use Subzero! Get started with: