search

JuliaGeodynamics / LaMEM.jl

Julia interface to LaMEM (Lithosphere and Mantle Evolution Model)
GNU General Public License v3.0
30 stars 13 forks source link

Add passive tracers documentation #61

Closed wenrongcao closed 1 month ago

wenrongcao commented 1 month ago

I added a md file called "readpassivetracer.md" and two associated images under /docs/src to show how to initiate tracers, perform tracer selection, and read the information back to Julia. No LaMEM source code is changed. Changes only exit in the /docs.

boriskaus commented 1 month ago

That’s great - thanks a lot.

I have two requests:

  1. Can you make a link to your document here ? That way a link to the page will appear in the side bar
  2. can you add a copy of the full, working, script to the examples directory? It would allow interested users to directly run this
wenrongcao commented 1 month ago

Will do. For (2), I do not see examples. Only see notebooks and scripts. Do you want me to make a new examples directory? Also, files in notebooks and scripts should be better sorted/combined if they all belong to examples.

boriskaus commented 1 month ago

Sorry, I meant scripts which is where we have the other examples as well

boriskaus commented 1 month ago

And feel free to better sort the scripts in those directories

boriskaus commented 1 month ago

since you rearranged the files in the scripts directory, the tests now fail (we always run these examples as part of the test to ensure that they keep working once we update the code). Can you perhaps update the file https://github.com/JuliaGeodynamics/LaMEM.jl/blob/main/test/test_examples.jl and while you are at it, you can also add your new example to the test.

wenrongcao commented 1 month ago

Ok, I see they are connected. Will fix these tomorrow.

wenrongcao commented 1 month ago

The Documentation check did not pass probably due to some (local?) path information related to Subduction3D.jl not being updated.

boriskaus commented 1 month ago

This is the error message:

ERROR: LoadError: Unable to generate remote link (local path does not exists)
 path: /home/runner/work/LaMEM.jl/LaMEM.jl/scripts/Subduction3D.jl

See here

The issue is in this line: https://github.com/JuliaGeodynamics/LaMEM.jl/blob/1c63624c55ebb12236a6695d6dacb8785fa750c0/docs/src/Subduction3D.md?plain=1#L2