Skip to content

Commit 58e10c3

Browse files
committed
Update Omega website docs and fix various typos
1 parent be590b2 commit 58e10c3

File tree

3 files changed

+37
-33
lines changed

3 files changed

+37
-33
lines changed

docs/src/develop.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -51,22 +51,22 @@ A crucial part of our PR process is **code review**. It is where your peers get
5151
## Add/modify entries in `dd`
5252

5353
The `dd` data structure is defined under the [IMASdd.jl](https://github.com/ProjectTorreyPines/IMASdd.jl) package.
54-
See the documentation there to how add/modify entries in `dd`.
54+
See the documentation there for how to add/modify entries in `dd`.
5555

5656
## Write a new actor
5757

5858
See the Jupyter [new actor tutorial](https://github.com/ProjectTorreyPines/FuseExamples/blob/master/new_actor.ipynb)
5959

6060
## Add/modify examples
6161

62-
The [FuseExamples repository](https://github.com/ProjectTorreyPines/FuseExamples) contains jupyter notebook that showcase some possible uses of FUSE.
62+
The [FuseExamples repository](https://github.com/ProjectTorreyPines/FuseExamples) contains jupyter notebooks that showcase some possible uses of FUSE.
6363

6464
!!! note
65-
When committing changes to in a jupyter notebook, make sure that all the output cells are cleared! This is important to keep the size of the repository in check.
65+
When committing changes to a jupyter notebook, make sure that all the output cells are cleared! This is important to keep the size of the repository in check.
6666

6767
## Add/modify a new cluster
6868

69-
The `parallel_environment()` function is used to easily setup the working environment for distributed jobs. Edit it [here](https://github.com/search?q=repo%3AProjectTorreyPines%2FFUSE.jl+%22function+parallel_environment%22&type=code) with your own cluster, folllowing the others as a template.
69+
The `parallel_environment()` function is used to easily setup the working environment for distributed jobs. Edit it [here](https://github.com/search?q=repo%3AProjectTorreyPines%2FFUSE.jl+%22function+parallel_environment%22&type=code) with your own cluster, following the others as a template.
7070

7171
## Write IMAS physics functions
7272

@@ -94,14 +94,14 @@ end
9494

9595
## Add/modify entries in `ini` and `act`
9696

97-
The functinoality of the `ini` and `act` parameters is implemented in the [SimulationParameters.jl](https://github.com/ProjectTorreyPines/SimulationParameters.jl) package.
97+
The functionality of the `ini` and `act` parameters is implemented in the [SimulationParameters.jl](https://github.com/ProjectTorreyPines/SimulationParameters.jl) package.
9898

9999
* The `ini` parameters are all defined in the `FUSE/src/parameters_init.jl` file. Add/edit entries there.
100100
* The `act` parameters of each actor are defined where that actor is defined. Add/edit entries there.
101101

102102
## Profiling and writing fast Julia code
103103

104-
First let's do some profiling to identify problemetic functions:
104+
First let's do some profiling to identify problematic functions:
105105

106106
1. Run FUSE from the VScode Julia REPL (`<Command-Shift-p>` and then `Julia: Start REPL`)
107107
```julia
@@ -118,7 +118,7 @@ First let's do some profiling to identify problemetic functions:
118118

119119
1. Use `@time` to monitor execution time and allocations
120120

121-
1. For functions that return very quickly one can use `BenchmarkTooks.@benchmark`
121+
1. For functions that return very quickly one can use `BenchmarkTools.@benchmark`
122122

123123
1. Graphical profiling of the execution time is a powerful way to understand where time is spent
124124
```julia
@@ -265,7 +265,7 @@ This can be particularly useful for benchmarking FUSE physics against existing P
265265
```
266266

267267
!!! note
268-
If you have more than one Julia version on our system, we could specify it with an argument:
268+
If you have more than one Julia version on your system, we could specify it with an argument:
269269
```
270270
julia.install(julia="/Users/meneghini/.julia/juliaup/julia-1.8.5+0.x64.apple.darwin14/bin/julia")
271271
```

docs/src/install.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ We highly recommend using the [Juliaup](https://github.com/JuliaLang/juliaup) ma
66
* Mac & Linux: `curl -fsSL https://install.julialang.org | sh`
77
* Windows: `winget install julia -s msstore --accept-source-agreements --accept-package-agreements`
88

9-
Once installed, restart your termninal to pick-up the `julia` executable.
9+
Once installed, restart your terminal to pick-up the `julia` executable.
1010

1111
## FUSE installation
1212

@@ -57,7 +57,7 @@ For installation start your Julia interpreter by typing `julia` at the terminal,
5757

5858
Make sure WebIO is working with `jupyter labextension list`. If it is working properly, you should see something like: webio-jupyterlab-provider v0.1.0 enabled OK (python, webio_jupyter_extension). This can also be checked with `jupyter nbextension list`, which should show something like: webio-jupyter-nbextension/nbextension enabled.
5959

60-
If the extension has compatibility issues, install an older verision of Jupyter (eg. `conda install jupyterlab=3.6.7`). Also ensure that the WebIO and Interact packages are fully up-to-date, and restart the notebook session before testing that it works. Finally, it may be necessary to downgrade your system's version of Python - the recommended version for compatibility with Interact is 3.11.11.
60+
If the extension has compatibility issues, install an older version of Jupyter (eg. `conda install jupyterlab=3.6.7`). Also ensure that the WebIO and Interact packages are fully up-to-date, and restart the notebook session before testing that it works. Finally, it may be necessary to downgrade your system's version of Python - the recommended version for compatibility with Interact is 3.11.11.
6161

6262
1. Install the `IJulia` package by running:
6363

docs/src/install_omega.md

Lines changed: 27 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# On GA's OMEGA cluster
22

3+
!!! note
4+
FUSE should only be run on `somega` or on a worker node, never on the `omega` login nodes.
5+
36
## FUSE module
47

58
If you only intend to use FUSE and don't plan to develop the source code, release versions of FUSE
@@ -31,37 +34,18 @@ The FUSE module does several things:
3134
start a Jupyter session and select the desired kernels. There is a kernel with 1 thread meant
3235
for the login nodes and 10 & 16 threads for the worker nodes.
3336
!!! warning
34-
**Problem**: There's a bug that may occur when a new user first launches one of these
37+
**Potential Problem**: There's a bug that may occur when a new user first launches one of these
3538
Julia + FUSE Jupyter kernels.
36-
In your terminal, you will see output about precompiling IJulia, which is expected.
39+
In your terminal, you may see output about precompiling IJulia, which is expected.
3740
Once the precompilation is done, it will report `Starting kernel event loops` but then the
3841
kernel may hang and your notebook may not work. It is unclear why this happens, but it is
3942
only the first time for each user.
4043

41-
**Solution**: Restart the kernel. Occasionally this needs to be done twice, perhaps if you
44+
**Solution**: The latest installations on Omega seemed to have fixed this issue, but if it happens,
45+
restart the kernel. Occasionally this needs to be done twice, perhaps if you
4246
restart too quickly and the precompilation was not finished. In any case, if the problem
4347
does not resolve after restarting the kernel twice, reach out to the FUSE developers.
4448

45-
## Running Julia/FUSE via VScode
46-
47-
The simplest way to start using FUSE is with [VScode and remote SHH connection](https://code.visualstudio.com/docs/remote/ssh-tutorial) to Omega.
48-
49-
To do this:
50-
51-
* Open a remote connection to Omega
52-
53-
* Install the `Julia` and the `Jupyter` VScode extensions in on Omega
54-
55-
* Open the `Code > Settings... > Settings` menu
56-
57-
* Select the `Remote [SSH: omega]` tab
58-
59-
* Search for `julia executable` in the search bar
60-
61-
* Edit the `julia: Executable Path` to `/fusion/projects/codes/julia/fuse/julia_with_fuse`
62-
63-
Now Julia scripts and notebooks can be run directly from this remote VScode session.
64-
6549
## Connecting to a Jupyter-lab server running on OMEGA from your laptop
6650

6751
1. Connect to `omega` and launch `screen`
@@ -139,6 +123,26 @@ Keep in mind that each worker node on Omega has 128 CPUs
139123

140124
Here we will use the `FUSE.parallel_environment("omega", ...)` call.
141125

126+
## Running Julia/FUSE via VScode
127+
128+
You can use [VScode and remote SHH connection](https://code.visualstudio.com/docs/remote/ssh-tutorial) to run Julia and FUSE on Omega.
129+
130+
To do this:
131+
132+
* Open a remote connection to Omega
133+
134+
* Install the `Julia` and the `Jupyter` VScode extensions in on Omega
135+
136+
* Open the `Code > Settings... > Settings` menu
137+
138+
* Select the `Remote [SSH: omega]` tab
139+
140+
* Search for `julia executable` in the search bar
141+
142+
* Edit the `julia: Executable Path` to `/fusion/projects/codes/julia/fuse/julia_with_fuse`
143+
144+
Now Julia scripts and notebooks can be run directly from this remote VScode session.
145+
142146
## Using Revise on Omega
143147
When working on omega it seems ones need to manually trigger revise to pick up code changes:
144148
```

0 commit comments

Comments
 (0)