Map of institutions in documentation

festim-dev / FESTIM

Coupled hydrogen/tritium transport and heat transfer modelling using FEniCS

https://festim.readthedocs.io/en/stable/

Apache License 2.0

78 stars 16 forks source link

Map of institutions in documentation #761

Closed RemDelaporteMathurin closed 2 months ago

RemDelaporteMathurin commented 2 months ago

Proposed changes

This PR adds an interactive map of institutions using FESTIM in the documentation, alongside with script to reproduce it

Types of changes

What types of changes does your code introduce to FESTIM?

[ ] Bugfix (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)
[ ] Code refactoring
[x] Documentation Update (if none of the other choices apply)
[ ] New tests

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 99.51%. Comparing base (fdfcb17) to head (a718eb4). Report is 34 commits behind head on main.

:exclamation: Current head a718eb4 differs from pull request most recent head 07350e9. Consider uploading reports for the commit 07350e9 to get more accurate results

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #761 +/- ## ========================================== + Coverage 99.48% 99.51% +0.02% ========================================== Files 58 58 Lines 2350 2468 +118 ========================================== + Hits 2338 2456 +118 Misses 12 12 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

KulaginVladimir commented 2 months ago

@RemDelaporteMathurin Looks cool!

Just a couple of questions.

Should it be above the contents? As an example, the list of institutions/organisations can be on a dedicated page, but not necessary.

What are these blue areas? Polygons which vertices are the institutions/organisations?

How did you place the institutions/organisations? For example, MEPhI is rather here :)

RemDelaporteMathurin commented 2 months ago

Should it be above the contents? As an example, the list of institutions/organisations can be on a dedicated page, but not necessary.

I kind of like the idea that it would be on the front page but we can also have a dedicated page. One day we may have also a list of publications associated with each institution? who knows!

What are these blue areas? Polygons which vertices are the institutions/organisations?

I think that is yes

How did you place the institutions/organisations? For example, MEPhI is rather here :)

I asked ChatGPT!!! thanks for pointing this out I'll correct it