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

Add passive tracers documentation #61

Merged
merged 10 commits into from
Sep 3, 2024
Merged

Conversation

wenrongcao
Copy link
Contributor

@wenrongcao wenrongcao commented Aug 30, 2024

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
Copy link
Member

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
Copy link
Contributor Author

wenrongcao commented Aug 31, 2024

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
Copy link
Member

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

@boriskaus
Copy link
Member

And feel free to better sort the scripts in those directories

@boriskaus
Copy link
Member

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
Copy link
Contributor Author

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

@wenrongcao
Copy link
Contributor Author

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

@boriskaus
Copy link
Member

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:

EditURL = "../../scripts/Subduction3D.jl"

@boriskaus boriskaus merged commit 608f1c8 into JuliaGeodynamics:main Sep 3, 2024
13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants