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.

Sign up for GitHub

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

Jump to bottom

Download meshes for tutorials #1037

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
+25 −19
Open

Download meshes for tutorials #1037

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c55a12e
Download mesh for comphom tutorial
KnutAM Aug 2, 2024
e5a7fd7
Fix notebook link
KnutAM Aug 2, 2024
99b2a9d
Fix test
KnutAM Aug 2, 2024
f36e8df
Download mesh for porous media
KnutAM Aug 3, 2024
ad17cd4
using Downloads in porous media example
KnutAM Aug 3, 2024
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
2 changes: 0 additions & 2 deletions docs/download_resources.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,6 @@ const directory = joinpath(@__DIR__, "src", "tutorials")
mkpath(directory)

for (file, url) in [
"periodic-rve.msh" => "https://raw.githubusercontent.com/Ferrite-FEM/Ferrite.jl/gh-pages/assets/periodic-rve.msh",
"periodic-rve-coarse.msh" => "https://raw.githubusercontent.com/Ferrite-FEM/Ferrite.jl/gh-pages/assets/periodic-rve-coarse.msh",
"transient_heat.gif" => "https://raw.githubusercontent.com/Ferrite-FEM/Ferrite.jl/gh-pages/assets/transient_heat.gif",
"transient_heat_colorbar.svg" => "https://raw.githubusercontent.com/Ferrite-FEM/Ferrite.jl/gh-pages/assets/transient_heat_colorbar.svg",
"porous_media.gif" => "https://raw.githubusercontent.com/Ferrite-FEM/Ferrite.jl/gh-pages/assets/porous_media.gif",
Expand Down
24 changes: 14 additions & 10 deletions docs/src/literate-tutorials/computational_homogenization.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
#-
#md # !!! tip
#md # This example is also available as a Jupyter notebook:
#md # [`computational_homogenization.ipynb`](@__NBVIEWER_ROOT_URL__/examples/computational_homogenization.ipynb).
#md # [`computational_homogenization.ipynb`](@__NBVIEWER_ROOT_URL__/tutorials/computational_homogenization.ipynb).
#-
#
# ## Introduction
Expand Down Expand Up @@ -197,17 +197,21 @@ using FerriteGmsh
#src notebook: use coarse mesh to decrease build time
#src script: use the fine mesh
#src markdown: use the coarse mesh to decrease build time, but make it look like the fine
#nb ## grid = togrid("periodic-rve.msh")
#nb grid = togrid("periodic-rve-coarse.msh")
#jl ## grid = togrid("periodic-rve-coarse.msh")
#jl grid = togrid("periodic-rve.msh")
#md grid = togrid("periodic-rve.msh")
#-
import Downloads #hide
meshfile = "periodic-rve.msh" #src
#jl meshfile = "periodic-rve.msh"
#md meshfile = "periodic-rve-coarse.msh" #hide
#nb meshfile = "periodic-rve-coarse.msh"
isfile(meshfile) || Downloads.download( #hide
string("https://raw.githubusercontent.com/Ferrite-FEM/Ferrite.jl/gh-pages/assets/", meshfile), #hide
meshfile) #hide
grid = togrid(meshfile) #src
#nb grid = togrid(meshfile)
Comment on lines +201 to +210
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wouldn't it be easier to add docs for the download file (i.e. docs/download_resources) instead of moving the download logic into the tutorial files? I think having a central point where the external resources are defined for the download is easier to maintain in the long run than splitting it apart like this,.

Copy link
Member Author

@KnutAM KnutAM Aug 2, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thinking about it, but for a user who copies the tutorial, it is nice to be able to copy the code and run directly I suppose?

Or did you mean to include via literate, so that the shown case (in cases we actually show the downloads in the docs) will include (part of) the code in docs/download_resources? (ref)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think having a central point where the external resources are defined for the download is easier to maintain in the long run than splitting it apart like this,.

These are tutorials that should be able to be runnable by someone reading them so whatever is done it should be visible from the source code itself.

Copy link
Member Author

@KnutAM KnutAM Aug 2, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One solution would be to add a non-exported function

asset_url(file) = string("https://raw.githubusercontent.com/Ferrite-FEM/Ferrite.jl/gh-pages/assets/", file)

to Ferrite itself, which would at least allow using

isfile(meshfile) || Downloads.download(Ferrite.asset_url(meshfile), meshfile)

above, which looks prettier at least, and would allow changing the location of the assets easily in the future. But feels ugly to add such things to the base package?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Currently, this is only used in two places, so I suggest to do it this "distributed" way for now, to solve #1033. Would be great with a nice solution including a "central point" in the future though.

#md grid = redirect_stdout(devnull) do #hide
#md togrid("periodic-rve-coarse.msh") #hide
#md end #hide

grid = togrid("periodic-rve.msh") #src
#md togrid(meshfile) #hide
#md end #hide
#md grid

# Next we construct the interpolation and quadrature rule, and combining them into
# cellvalues as usual:
Expand Down
7 changes: 3 additions & 4 deletions test/test_examples.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,11 @@ end
# end

module TestComputationalHomogenization
include(joinpath(@__DIR__, "../docs/download_resources.jl"))
mktempdir() do dir
cd(dir) do
cp(joinpath(@__DIR__, "../docs/src/tutorials/periodic-rve.msh"),
joinpath(dir, "periodic-rve.msh")
)
# Add already downloaded file to allow running test suite offline
mesh_file = joinpath(@__DIR__, "../docs/src/tutorials/periodic-rve.msh")
isfile(mesh_file) && cp(mesh_file, joinpath(dir, basename(mesh_file)))
include(joinpath(@__DIR__, "../docs/src/literate-tutorials/computational_homogenization.jl"))
end
end
Expand Down