From 4c6b581ee175033c7fad7feaea27b7567d994ed7 Mon Sep 17 00:00:00 2001 From: PandaHUN777 <117030640+PandaHUN777@users.noreply.github.com> Date: Mon, 28 Sep 2026 03:58:53 +0200 Subject: [PATCH 1/3] docs: update MOLE.jl installation instructions --- julia/MOLE.jl/README.md | 2 +- julia/MOLE.jl/docs/src/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/julia/MOLE.jl/README.md b/julia/MOLE.jl/README.md index abf6e89ab..a55dddcae 100644 --- a/julia/MOLE.jl/README.md +++ b/julia/MOLE.jl/README.md @@ -6,7 +6,7 @@ This is an implementation written in Julia for the MOLE package. The source file ## Installation -MOLE.jl is not yet available in the Julia's package manager. For now, this repository needs to be cloned locally in order to use the library in Julia. +MOLE.jl is available from the Julia package manager. In Julia, run `using Pkg; Pkg.add("MOLE")` to install it. ## Using MOLE.jl diff --git a/julia/MOLE.jl/docs/src/index.md b/julia/MOLE.jl/docs/src/index.md index 0f6c1f915..a4f1b3a7b 100644 --- a/julia/MOLE.jl/docs/src/index.md +++ b/julia/MOLE.jl/docs/src/index.md @@ -6,7 +6,7 @@ More information can be found on the [main documentation site](https://mole-docs ## Getting Started -MOLE.jl is not yet available in the Julia's package manager. For now, this repository needs to be cloned locally in order to use the library. +MOLE.jl is available from the Julia package manager. In Julia, run `using Pkg; Pkg.add("MOLE")` to install it. ## Using MOLE.jl From cc08ed32b22adb3f1055013833f6f5c5b8f85a4b Mon Sep 17 00:00:00 2001 From: PandaHUN777 <117030640+PandaHUN777@users.noreply.github.com> Date: Mon, 28 Sep 2026 19:47:03 +0200 Subject: [PATCH 2/3] docs: update MOLE.jl usage instructions to separate package usage from local development --- julia/MOLE.jl/README.md | 30 +++++++++++++++++++++++++----- julia/MOLE.jl/docs/src/index.md | 32 ++++++++++++++++++++++++++------ 2 files changed, 51 insertions(+), 11 deletions(-) diff --git a/julia/MOLE.jl/README.md b/julia/MOLE.jl/README.md index a55dddcae..178827906 100644 --- a/julia/MOLE.jl/README.md +++ b/julia/MOLE.jl/README.md @@ -10,21 +10,41 @@ MOLE.jl is available from the Julia package manager. In Julia, run `using Pkg; P ## Using MOLE.jl -In order to use the MOLE.jl library, first navigate to the location where the repository has been cloned to. Then, go to the `mole/julia/MOLE.jl` sub-directory. From here, you can access the library via the REPL or the command line. +Once installed, load the library in Julia with: -### From the REPL +```julia +using MOLE +``` + +Then, to run a script such as `myScript.jl`, you can use the following command in the REPL: + +```julia +include("path/to/myScript.jl") +``` + +or run it from the command line: + +```sh +julia path/to/myScript.jl +``` + +### Development and working from source + +If you are developing MOLE.jl or working directly from a cloned repository, navigate to the `mole/julia/MOLE.jl` sub-directory. From here, you can access the library via the REPL or the command line. + +#### From the REPL In `mole/julia/MOLE.jl`, start Julia using the command `julia --project=.`. Next, the package library needs to be instantiated and pre-compiled. Enter the `pkg` mode by pressing `]`, then type the commands `instantiate` and `precompile` (one at a time). This should activate the MOLE.jl package and install the necessary dependencies. -Then, to run a script such as myScript.jl, you can use the following command in the REPL: +Then, to run a script such as `myScript.jl`, you can use the following command in the REPL: ```julia include("path/to/myScript.jl") ``` -### From the command line +#### From the command line -In `mole/julia/MOLE.jl`, use the following commands to instatiate and precompile the MOLE package: +In `mole/julia/MOLE.jl`, use the following commands to instantiate and precompile the MOLE package: ```sh julia --project=. -e 'using Pkg; Pkg.instantiate()' diff --git a/julia/MOLE.jl/docs/src/index.md b/julia/MOLE.jl/docs/src/index.md index a4f1b3a7b..d94c3081d 100644 --- a/julia/MOLE.jl/docs/src/index.md +++ b/julia/MOLE.jl/docs/src/index.md @@ -4,27 +4,47 @@ MOLE is a library that implements high-order mimetic operators to solve partial This site provides documentation for the Julia implementation of MOLE. More information can be found on the [main documentation site](https://mole-docs.readthedocs.io/en/main/) and the [GitHub repository](https://github.com/csrc-sdsu/mole). -## Getting Started +## Installation MOLE.jl is available from the Julia package manager. In Julia, run `using Pkg; Pkg.add("MOLE")` to install it. ## Using MOLE.jl -In order to use the MOLE.jl library, first navigate to the location where the repository has been cloned to. Then, go to the `mole/julia/MOLE.jl` sub-directory. From here, you can access the library via the REPL or the command line. +Once installed, load the library in Julia with: -### From the REPL +```julia +using MOLE +``` + +Then, to run a script such as `myScript.jl`, you can use the following command in the REPL: + +```julia +include("path/to/myScript.jl") +``` + +or run it from the command line: + +```sh +julia path/to/myScript.jl +``` + +### Development and working from source + +If you are developing MOLE.jl or working directly from a cloned repository, navigate to the `mole/julia/MOLE.jl` sub-directory. From here, you can access the library via the REPL or the command line. + +#### From the REPL In `mole/julia/MOLE.jl`, start Julia using the command `julia --project=.`. Next, the package library needs to be instantiated and pre-compiled. Enter the `pkg` mode by pressing `]`, then type the commands `instantiate` and `precompile` (one at a time). This should activate the MOLE.jl package and install the necessary dependencies. -Then, to run a script such as myScript.jl, you can use the following command in the REPL: +Then, to run a script such as `myScript.jl`, you can use the following command in the REPL: ```julia include("path/to/myScript.jl") ``` -### From the command line +#### From the command line -In `mole/julia/MOLE.jl`, use the following commands to instatiate and precompile the MOLE package: +In `mole/julia/MOLE.jl`, use the following commands to instantiate and precompile the MOLE package: ```sh julia --project=. -e 'using Pkg; Pkg.instantiate()' From ea303cd3ceafef1e9458f8047569f3369e9475b3 Mon Sep 17 00:00:00 2001 From: PandaHUN777 <117030640+PandaHUN777@users.noreply.github.com> Date: Mon, 28 Sep 2026 20:20:53 +0200 Subject: [PATCH 3/3] docs: add Julia package REPL mode installation alternative --- julia/MOLE.jl/README.md | 2 +- julia/MOLE.jl/docs/src/index.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/julia/MOLE.jl/README.md b/julia/MOLE.jl/README.md index 178827906..72e29e006 100644 --- a/julia/MOLE.jl/README.md +++ b/julia/MOLE.jl/README.md @@ -6,7 +6,7 @@ This is an implementation written in Julia for the MOLE package. The source file ## Installation -MOLE.jl is available from the Julia package manager. In Julia, run `using Pkg; Pkg.add("MOLE")` to install it. +MOLE.jl is available from the Julia package manager. In Julia, run `using Pkg; Pkg.add("MOLE")` to install it. Alternatively, enter Julia's package mode by pressing `]` and run `add MOLE`. ## Using MOLE.jl diff --git a/julia/MOLE.jl/docs/src/index.md b/julia/MOLE.jl/docs/src/index.md index d94c3081d..5f9cbf4a4 100644 --- a/julia/MOLE.jl/docs/src/index.md +++ b/julia/MOLE.jl/docs/src/index.md @@ -6,7 +6,7 @@ More information can be found on the [main documentation site](https://mole-docs ## Installation -MOLE.jl is available from the Julia package manager. In Julia, run `using Pkg; Pkg.add("MOLE")` to install it. +MOLE.jl is available from the Julia package manager. In Julia, run `using Pkg; Pkg.add("MOLE")` to install it. Alternatively, enter Julia's package mode by pressing `]` and run `add MOLE`. ## Using MOLE.jl