Skip to content

Commit

Permalink
Update docs to be compatible with Julia v1.10.2
Browse files Browse the repository at this point in the history
  • Loading branch information
EdoAlvarezR committed Apr 16, 2024
1 parent 53e94a4 commit 0f49d5c
Show file tree
Hide file tree
Showing 5 changed files with 20 additions and 15 deletions.
4 changes: 4 additions & 0 deletions docs/Project.toml
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8"

[compat]
Documenter = "0.27"
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
Build docs:
* Install Documenter in Julia: `] add Documenter.jl`
* Install Documenter in Julia: `] add Documenter#v0.27.25`
* Compile source files: `julia make.jl`(this will generate html files in `build/`
and push/deploy the documentation to GitHub Pages)

> You can also manually deploy documentation into the gh-pages branch for
Github Pages: `mkdocs gh-deploy`. You will need to roll jinja2 back to v3.0.3
Github Pages: `mkdocs gh-deploy`. You will need to roll jinja2 back to v3.0.3
for mkdocs to work: `pip install --force-reinstall -v "jinja2==3.0.3"`.

Launching docs page (`build/`) locally:
Expand Down
3 changes: 1 addition & 2 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -237,8 +237,7 @@ See the following publications for an in-depth dive into the theory and validati



**Ducted Fan:** [[Slides](http://edoalvar2.groups.et.byu.net/public/FLOWUnsteady/alvarez_2023-SLIDES-VPM_for_EDF_in_Non_Axisymmetric_Flow.pdf
)]
**Ducted Fan:** [[Slides](http://edoalvar2.groups.et.byu.net/public/FLOWUnsteady/alvarez_2023-SLIDES-VPM_for_EDF_in_Non_Axisymmetric_Flow.pdf)]

```@raw html
<div style="position:relative;padding-top:50%;">
Expand Down
16 changes: 8 additions & 8 deletions docs/src/installation/general.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ FLOWUnsteady.
## Julia

* Download and install Julia: [julialang.org](https://julialang.org/downloads)
(currently we are only supporting up to Julia v1.8.5, so we recommend using
[v1.8.5](https://julialang.org/downloads/oldreleases/) or
(currently we are supporting up to Julia v1.10, so we recommend using
[v1.10.2](https://julialang.org/downloads) or
[v1.6.7 LTS](https://julialang.org/downloads/#long_term_support_release)
)
* Add Julia to user-level `bin` folder
Expand All @@ -28,7 +28,7 @@ FLOWUnsteady.
Replace `/[user-specific-path/Julia-1.x.x]/` with the path where Julia got
installed.
For instance, in MacOS the full path looks like this:
`/Applications/Julia-1.8.app/Contents/Resources/julia/bin/julia`
`/Applications/Julia-1.10.app/Contents/Resources/julia/bin/julia`

If you were successfull, typing the following in the terminal will launch the
Julia REPL:
Expand All @@ -47,7 +47,7 @@ julia
Replace `/[user-specific-path/ParaView-5.x.x]/` with the path where ParaView got
installed.
For instance, in MacOS the full path looks like this:
`/Applications/ParaView-5.11.0.app/Contents/MacOS/paraview`
`/Applications/ParaView-5.12.0.app/Contents/MacOS/paraview`

If you were successfull, typing the following in the terminal will launch the
ParaView:
Expand Down Expand Up @@ -136,7 +136,7 @@ first you will have to install FLOWExaFMM and compile ExaFMM, as follows.
* *[Julia REPL]* Install CxxWrap:
```julia
import Pkg
Pkg.add(name="CxxWrap", version="0.11.2")
Pkg.add(name="CxxWrap", version="0.15.0")
```

* *[Terminal]* Clone FLOWExaFMM:
Expand Down Expand Up @@ -175,7 +175,7 @@ add FLOWVPM:
```julia
] test FLOWExaFMM
```
This will return a heart-warming "Hello world!" if ExaFMM was correctly compiled.
If ExaFMM was correctly compiled, this will return a heart-warming "Hello world!"


* Add FLOWVPM:
Expand Down Expand Up @@ -219,8 +219,8 @@ import Pkg

url = "https://github.com/byuflowlab/"

packages = (("AirfoilPrep.jl", "v2.1.2"), ("FLOWVLM", "v2.1.2"),
("BPM.jl", "v2.0.1"), ("FLOWNoise", "v2.3.2"))
packages = [ ("AirfoilPrep.jl", "v2.1.2"), ("FLOWVLM", "v2.1.2"),
("FLOWNoise", "v2.3.3"), ("BPM.jl", "v2.0.1") ]

Pkg.add([ Pkg.PackageSpec(; url=url*name, rev=v) for (name, v) in packages ])
```
Expand Down
8 changes: 5 additions & 3 deletions docs/src/installation/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,17 +33,19 @@ Once inside WSL, do the following
```

## Install Julia
Still inside WSL,

* Download Julia:
```bash
wget -O julia.tar.gz "https://julialang-s3.julialang.org/bin/linux/x64/1.8/julia-1.8.5-linux-x86_64.tar.gz"
wget -O julia.tar.gz "https://julialang-s3.julialang.org/bin/linux/x64/1.10/julia-1.10.2-linux-x86_64.tar.gz"
```
* Decompress Julia:
```bash
tar -xvf julia.tar.gz -C ~/Programs/
```
* Add Julia to user-level path:
```bash
sudo ln -s ~/Programs/julia-1.8.5/bin/julia /usr/local/bin/
sudo ln -s ~/Programs/julia-1.10.2/bin/julia /usr/local/bin/
```

## Install ParaView
Expand All @@ -64,4 +66,4 @@ Once inside WSL, do the following
---

**Now you can proceed with [the general instructions](@ref installation)**
(you can skip the Julia and ParaView since we already took care of that)
(you can skip the Julia and ParaView instructions since we already took care of that)

0 comments on commit 0f49d5c

Please sign in to comment.