From 7d23f7e0a9f926a5dc1d83f8886aa6a7b484b975 Mon Sep 17 00:00:00 2001 From: Martijn Visser Date: Sun, 5 Nov 2023 12:28:27 +0100 Subject: [PATCH] update docs and settings template --- .vscode/settings_template.json | 1 - docs/contribute/core.qmd | 15 ++------------- 2 files changed, 2 insertions(+), 14 deletions(-) diff --git a/.vscode/settings_template.json b/.vscode/settings_template.json index 852168c6d..bd65da885 100644 --- a/.vscode/settings_template.json +++ b/.vscode/settings_template.json @@ -2,7 +2,6 @@ "[julia]": { "editor.formatOnSave": true }, - "julia.environmentPath": "core", "notebook.formatOnSave.enabled": true, "[python]": { "editor.defaultFormatter": "charliermarsh.ruff", diff --git a/docs/contribute/core.qmd b/docs/contribute/core.qmd index ce2815dc4..e54755f30 100644 --- a/docs/contribute/core.qmd +++ b/docs/contribute/core.qmd @@ -62,7 +62,7 @@ Before the tests can run, you need to [prepare model input](./python.qmd#prepare With the root of the repository as your working directory you can start the REPL with activated `Ribasim` environment by running the following: ```bash -julia --project=core +julia --project ``` While not technically required, it is advised to import Ribasim first to catch installation issues early on. @@ -73,12 +73,6 @@ julia> using Ribasim Then open the Pkg REPL by typing `]` and execute: -```julia -pkg> test -``` - -If you are in a different environment that depends on Ribasim, you can test Ribasim with the following command: - ```julia pkg> test Ribasim ``` @@ -94,11 +88,6 @@ using TestEnv TestEnv.activate() ``` -:::{.callout-tip} -The Julia VS Code extension allows you to [open a REPL](https://www.julia-vscode.org/docs/stable/userguide/runningcode/#The-Julia-REPL) with the Ribasim environment already activated: `"julia.environmentPath": "Ribasim/core"`. -That way you don't have to type `activate core` every time you open the REPL. -::: - ## Render documentation Example models are created and simulated as part of the rendering of the documentation. @@ -131,7 +120,7 @@ Assuming your working directory is the root of the repository, you can activate this project by entering the Pkg mode of the REPL with `]` and execute: ```julia -pkg> activate core +pkg> activate . pkg> instantiate ```