Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merge dev: Compatibility with Julia v1.10 #164

Merged
merged 5 commits into from
Dec 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions Project.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name = "FLOWUnsteady"
uuid = "b491798d-ac6e-455f-a27c-49c10bb0a666"
authors = ["Eduardo J. Alvarez <Edo.AlvarezR@gmail.com> and contributors"]
version = "3.3.0"
version = "3.3.2"

[deps]
PyPlot = "d330b81b-6aea-500a-939a-2ce795aea3ee"
Expand All @@ -21,10 +21,10 @@ VSPGeom = "9b3f6a95-fce2-4bc5-94a2-f99b39986ea6"

[compat]
julia = "1.6"
GeometricTools = "2.1.6"
FLOWVPM = "3.0.1"
FLOWVLM = "2.1.2"
FLOWNoise = "2.3.2"
GeometricTools = "2.2"
FLOWVPM = "3.0"
FLOWVLM = "2.1.3"
FLOWNoise = "2.3.3"
BPM = "2.0.1"

[extras]
Expand Down
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
36 changes: 15 additions & 21 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 @@ -81,6 +81,13 @@ ParaView will then pull up with a rendering of a cube (click the `Apply` button
</p>
```

## *(Optional)* OpenVSP
FLOWUnsteady can import geometry created in [OpenVSP](https://openvsp.org/) using [VSPGeom.jl](https://github.com/byuflowlab/VSPGeom.jl).
We recommend [installing OpenVSP](https://openvsp.org/download.php) in your system, then adding VSPGeom.jl to Julia:
```julia
] add VSPGeom
```


## [PyCall](@id pycall)

Expand Down Expand Up @@ -136,7 +143,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 +182,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 All @@ -198,19 +205,6 @@ If you run into any issues, please try the following:
If issues persist, please check the resolved issues in [the FLOWExaFMM repo](https://github.com/byuflowlab/FLOWExaFMM.jl/issues?q=), the discussion forum in [the FLOWUnsteady repo](https://github.com/byuflowlab/FLOWUnsteady/discussions?discussions_q=),
and feel free to open a new issue or discussion for help.

## VSPGeom
FLOWUnsteady can import geometry created in [OpenVSP](https://openvsp.org/) using [VSPGeom.jl](https://github.com/byuflowlab/VSPGeom.jl).

* Add VSPgeom:
```julia
] add VSPGeom
```

* *[Optional]* Test VSPGeom:
```julia
] test VSPGeom
```

## Other Packages
Run the following commands in the Julia REPL to add some dependencies that are not
in the official Julia registry:
Expand All @@ -219,8 +213,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.3"),
("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)
Loading