added symlinks for tardis_example.yml #1562

parikshit14 · 2021-05-11T08:05:49Z

Added Symlinks for tardis_example wherever they were needed

Description
Replaced the original file with symlinks:

tardis/docs/using/components/models/examples/tardis_example.yml

placed the original tardis_example.yml in tardis/docs

also added a symlink in tardis/docs/quickstart/ as it is generally used in quickstart.ipynb

Motivation and context

solves issue #1561

Type of change

Bug fix.
New feature.
Breaking change.
None of the above.

Checklist

My change requires a change to the documentation.
- I have updated the documentation accordingly.
- (optional) I have built the documentation on my fork following the instructions.
I have assigned and requested two reviewers for this pull request.
@smithis7 @wkerzendorf kindly verify the changes

codecov · 2021-05-11T08:16:04Z

Codecov Report

Merging #1562 (39a3202) into master (e3a35bb) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #1562   +/-   ##
=======================================
  Coverage   68.24%   68.24%           
=======================================
  Files          73       73           
  Lines        6373     6373           
=======================================
  Hits         4349     4349           
  Misses       2024     2024

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e3a35bb...39a3202. Read the comment docs.

atharva-2001 · 2021-05-11T10:11:11Z

docs/quickstart/tardis_example.yml

@@ -0,0 +1 @@
+/home/parikshit/Desktop/tardis/docs/tardis_example.yml


I guess you should use relative paths here. In this case, just ../tardis_example.yml should work.

thanks for rectifying the mistakes I really don't know how I missed them. Thanks again

isaacgsmith · 2021-05-11T13:14:39Z

Good start! A few things:

docs/research/code_comparison/plasma_compare/tardis_example.yml is actually a different YAML file from the one elsewhere in the documentation, so we want to leave it how it was. I can see where having it named tardis_example.yml could cause confusion, and that may be something to rename in the future.
There are several other occurrences of the YAML file throughout the documentation. They are all currently symlinks that direct to docs/using/components/models/examples/tardis_example.yml (so in this PR, you should only need to replace the actual file with a symlink once, and everything else will just be changing symlinks like you did with quickstart). To go about finding them all, you will want to build the documentation locally, and see where the notebooks fail to run (which will be the result of a broken symlink), and fix the symlink. You'll want to repeat this until the docs build properly. @epassaro once showed me a more efficient way to locate all broken symlinks, but I don't recall what it was (maybe he can comment how to do it).

parikshit14 · 2021-05-11T16:26:37Z

Good start! A few things:

docs/research/code_comparison/plasma_compare/tardis_example.yml is actually a different YAML file from the one elsewhere in the documentation, so we want to leave it how it was. I can see where having it named tardis_example.yml could cause confusion, and that may be something to rename in the future.

ok, I thought they were the same. Just checked and found the difference, no problem I will revert this back to normal.

There are several other occurrences of the YAML file throughout the documentation. They are all currently symlinks that direct to docs/using/components/models/examples/tardis_example.yml (so in this PR, you should only need to replace the actual file with a symlink once, and everything else will just be changing symlinks like you did with quickstart). To go about finding them all, you will want to build the documentation locally, and see where the notebooks fail to run (which will be the result of a broken symlink), and fix the symlink. You'll want to repeat this until the docs build properly. @epassaro once showed me a more efficient way to locate all broken symlinks, but I don't recall what it was (maybe he can comment how to do it).

ok, so all the existing symlinks(present originally in this repository) are reference from docs/using/components/models/examples/tardis_example.yml and not from docs/research/code_comparison/plasma_compare/tardis_example.yml. correct me if I am wrong! because this can again lead to a lot of confusion.

isaacgsmith · 2021-05-11T16:31:43Z

ok, so all the existing symlinks(present originally in this repository) are reference from docs/using/components/models/examples/tardis_example.yml and not from docs/research/code_comparison/plasma_compare/tardis_example.yml. correct me if I am wrong! because this can again lead to a lot of confusion.

Right. The issue I posted is only concerned with the file that was under docs/using/components/models/examples/tardis_example.yml, so you just need to change symlinks that point to docs/using/components/models/examples/tardis_example.yml so that they point to docs/tardis_example.yml.

parikshit14 · 2021-05-11T18:32:44Z

I tried to test the changes you recommended in the second part but apparently the symlinks are not broken i.e. the symlinks which are now pointing to the symlink of docs/tardis_example.yml (symlink -> symlink -> docs/tardis_example.yml) are working completely fine. I checked them using the notebooks given with them respectively and they work the same as they were working before.
But still, if you require I can update them to the current situation

isaacgsmith · 2021-05-11T19:12:55Z

I tried to test the changes you recommended in the second part but apparently the symlinks are not broken i.e. the symlinks which are now pointing to the symlink of docs/tardis_example.yml (symlink -> symlink -> docs/tardis_example.yml) are working completely fine. I checked them using the notebooks given with them respectively and they work the same as they were working before.

But still, if you require I can update them to the current situation

I see why that is. Technically, it would be fine, as the symlinks point to another symlink that points to the proper file, but I think it would be better to change them so they point directly to the proper place. I think you can find all of them by searching for tardis_example.yml in the TARDIS code.

parikshit14 · 2021-05-12T05:34:35Z

Updated as suggested!

isaacgsmith · 2021-05-12T14:54:25Z

Looks really good! This is my fault as I did not put this in the original issue, but as I was reviewing this I noticed that there is a link in docs/quickstart/quickstart.ipynb (3rd code cell) that points to the old location. That's the last link that points to the old location that I found, so if you can change that one I will approve the PR. Sorry again for missing that link in the original issue.

review-notebook-app · 2021-05-12T15:30:34Z

Check out this pull request on

See visual diffs & provide feedback on Jupyter Notebooks.

Powered by ReviewNB

parikshit14 · 2021-05-12T15:33:01Z

Looks really good! This is my fault as I did not put this in the original issue, but as I was reviewing this I noticed that there is a link in docs/quickstart/quickstart.ipynb (3rd code cell) that points to the old location. That's the last link that points to the old location that I found, so if you can change that one I will approve the PR. Sorry again for missing that link in the original issue.

no problem, I also missed it while I was testing quickstart.ipynb !!

isaacgsmith

Perfect!

* added symlinks for tardis_example.yml * updating symlinks * symlink corrections * updating quickstart

added symlinks for tardis_example.yml

6cdb5cf

atharva-2001 reviewed May 11, 2021

View reviewed changes

updating symlinks

a34b75e

symlink corrections

558133d

andrewfullard requested a review from isaacgsmith May 12, 2021 14:45

andrewfullard added the documentation label May 12, 2021

updating quickstart

39a3202

isaacgsmith approved these changes May 12, 2021

View reviewed changes

andrewfullard self-requested a review May 12, 2021 16:23

andrewfullard approved these changes May 12, 2021

View reviewed changes

andrewfullard merged commit 92b7e1d into tardis-sn:master May 12, 2021

andrewfullard linked an issue May 12, 2021 that may be closed by this pull request

Moving Config File Under docs/ #1561

Closed

isaacgsmith mentioned this pull request May 13, 2021

Fixing docs build problem #1569

Merged

10 tasks

atharva-2001 pushed a commit to atharva-2001/tardis that referenced this pull request Oct 1, 2021

added symlinks for tardis_example.yml (tardis-sn#1562)

6c2fdc0

* added symlinks for tardis_example.yml * updating symlinks * symlink corrections * updating quickstart

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

added symlinks for tardis_example.yml #1562

added symlinks for tardis_example.yml #1562

parikshit14 commented May 11, 2021 •

edited

Loading

codecov bot commented May 11, 2021 •

edited

Loading

atharva-2001 May 11, 2021 •

edited

Loading

parikshit14 May 11, 2021

isaacgsmith commented May 11, 2021

parikshit14 commented May 11, 2021

isaacgsmith commented May 11, 2021

parikshit14 commented May 11, 2021

isaacgsmith commented May 11, 2021 •

edited

Loading

parikshit14 commented May 12, 2021

isaacgsmith commented May 12, 2021

review-notebook-app bot commented May 12, 2021

parikshit14 commented May 12, 2021

isaacgsmith left a comment

		@@ -0,0 +1 @@
		/home/parikshit/Desktop/tardis/docs/tardis_example.yml

added symlinks for tardis_example.yml #1562

added symlinks for tardis_example.yml #1562

Conversation

parikshit14 commented May 11, 2021 • edited Loading

codecov bot commented May 11, 2021 • edited Loading

Codecov Report

atharva-2001 May 11, 2021 • edited Loading

Choose a reason for hiding this comment

parikshit14 May 11, 2021

Choose a reason for hiding this comment

isaacgsmith commented May 11, 2021

parikshit14 commented May 11, 2021

isaacgsmith commented May 11, 2021

parikshit14 commented May 11, 2021

isaacgsmith commented May 11, 2021 • edited Loading

parikshit14 commented May 12, 2021

isaacgsmith commented May 12, 2021

review-notebook-app bot commented May 12, 2021

parikshit14 commented May 12, 2021

isaacgsmith left a comment

Choose a reason for hiding this comment

parikshit14 commented May 11, 2021 •

edited

Loading

codecov bot commented May 11, 2021 •

edited

Loading

atharva-2001 May 11, 2021 •

edited

Loading

isaacgsmith commented May 11, 2021 •

edited

Loading