add the symlink to visualization examples

[yuyizheng1112]

Description

Changes made:
Add the configuration file tardis_example.yml to the directory: docs/using/visualization.

Motivation and Context

In generating_widgets.ipynb and sdec_plot.ipynb, the file path of function run_tardis() is 'tardis_example.yml', which directs to the file in the same directory as notebooks. Therefore, the configuration file should be added to the directory.

How Has This Been Tested?

• Testing pipeline
• Reference Data Comparison following these instructions
• Other (please describe)

Screenshots (if appropriate):

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• None of the above (please describe)

Checklist:

• My code follows the code style of this project
• My change requires a change to the documentation
• I have updated the documentation accordingly
• I have built the documentation on my fork following these instructions
• I have assigned and requested two reviewers for this pull request

[codecov]

Codecov Report

Merging #1478 (822ec0c) into master (09f992f) will decrease coverage by 0.00%.
The diff coverage is n/a.

❗ Current head 822ec0c differs from pull request most recent head ed964fb. Consider uploading reports for the commit ed964fb to get more accurate results

@@            Coverage Diff             @@
##           master    #1478      +/-   ##
==========================================
- Coverage   67.57%   67.57%   -0.01%     
==========================================
  Files          68       68              
  Lines        6100     6103       +3     
==========================================
+ Hits         4122     4124       +2     
- Misses       1978     1979       +1     

Impacted Files	Coverage Δ
...rdis/tardis/montecarlo/montecarlo_numba/vpacket.py	17.47% <0.00%> (-0.18%)	⬇️
tardis/tardis/plasma/properties/ion_population.py	86.27% <0.00%> (+0.13%)	⬆️

---

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 09f992f...ed964fb. Read the comment docs.

[marxwillia]

This seems reasonable to me. The one thing we might want to consider is that the tardis_example.yml file is going to be living in multiple places in the repository. We should think about other ways to make our common example files easily accessible, while minimizing copies. @jaladh-singhal any thoughts?

[isaacgsmith]

We use symbolic links for that file. The only real copy of tardis_example.yml is under docs/using/components/models/examples/-- this way, if we need to change it we only need to change one file.

@marxwillia is right though about accessibility. Perhaps we move the file somewhere easier to find, like just under docs/-- that would require changing all of the symlinks, so it would be a little bit of a task.

[andrewfullard]

Converting to draft until comments are addressed

[jaladh-singhal]

We use symbolic links for that file. The only real copy of tardis_example.yml is under docs/using/components/models/examples/-- this way, if we need to change it we only need to change one file.

I second this. @yuyizheng1112 can you create a symlink to above path (as of now for this PR) instead of copying config file?

@marxwillia is right though about accessibility. Perhaps we move the file somewhere easier to find, like just under docs/-- that would require changing all of the symlinks, so it would be a little bit of a task.

@marxwillia @andrewfullard where do you think is the best place to keep tardis_example.yml within repo? @yuyizheng1112 once this is decided, you can dig all existing tardis_example.yml files & symlinks and change them (as @smithis7 mentioned) in another PR.

[jaladh-singhal]

@yuyizheng1112 I think you're close, can you complete this PR with requested change (in comment above)?

[yuyizheng1112]

@yuyizheng1112 I think you're close, can you complete this PR with requested change (in comment above)?

Sorry that I just saw your comment and thanks for your guidance!

[yuyizheng1112]

We use symbolic links for that file. The only real copy of tardis_example.yml is under docs/using/components/models/examples/-- this way, if we need to change it we only need to change one file.

I second this. @yuyizheng1112 can you create a symlink to above path (as of now for this PR) instead of copying config file?

@marxwillia is right though about accessibility. Perhaps we move the file somewhere easier to find, like just under docs/-- that would require changing all of the symlinks, so it would be a little bit of a task.

@marxwillia @andrewfullard where do you think is the best place to keep tardis_example.yml within repo? @yuyizheng1112 once this is decided, you can dig all existing tardis_example.yml files & symlinks and change them (as @smithis7 mentioned) in another PR.

I am willing to take this task if the place of tardis_example would be changed.