Skip to content

Commit

Permalink
update docs and settings template
Browse files Browse the repository at this point in the history
  • Loading branch information
visr committed Nov 5, 2023
1 parent 16ce0cf commit 7d23f7e
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 14 deletions.
1 change: 0 additions & 1 deletion .vscode/settings_template.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@
"[julia]": {
"editor.formatOnSave": true
},
"julia.environmentPath": "core",
"notebook.formatOnSave.enabled": true,
"[python]": {
"editor.defaultFormatter": "charliermarsh.ruff",
Expand Down
15 changes: 2 additions & 13 deletions docs/contribute/core.qmd
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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
```
Expand All @@ -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.
Expand Down Expand Up @@ -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
```

Expand Down

0 comments on commit 7d23f7e

Please sign in to comment.