Skip to content

Commit

Permalink
Make useful links appear earlier in readme
Browse files Browse the repository at this point in the history
  • Loading branch information
@philbull
philbull authored Jun 30, 2024
1 parent cc95364 commit fe6e54a
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,13 @@ Hydra uses a technique called **Gibbs sampling** to efficiently draw samples fro
distribution of *all* the parameters. It is implemented in Python and is compatible with the data
formats used by the HERA pipeline, such as _UVData_ and _UVBeam_.

## Learn about the code and different 'heads' of Hydra

* See the [API documentation](https://hydraradio.github.io/Hydra/api/)
* Run the example script, [example.py](https://hydraradio.github.io/Hydra/example.html)
* Read the [frequently-asked questions](https://hydraradio.github.io/Hydra/faq.html) about the code and maths
* Learn about the different ["heads"](https://hydraradio.github.io/Hydra/heads.html) (conditional distribution samplers) of Hydra.

## What is Gibbs sampling?

Gibbs sampling is a way of breaking up the joint posterior distribution for a set of parameters into a
Expand Down Expand Up @@ -71,13 +78,6 @@ At present, Hydra is parallelised in a basic way, meaning that it can only run o
a single HPC node). There are plans to make a distributed version that can scale to much larger problem
sizes, but for now the main limitation is the amount of RAM available on each node.

## Learn about the code and different 'heads' of Hydra

* See the [API documentation](https://hydraradio.github.io/Hydra/api/)
* Run the example script, [example.py](https://hydraradio.github.io/Hydra/example.html)
* Read the [frequently-asked questions](https://hydraradio.github.io/Hydra/faq.html) about the code and maths
* Learn about the different ["heads"](https://hydraradio.github.io/Hydra/heads.html) (conditional distribution samplers) of Hydra.

## Who is behind Hydra?

Hydra is a project based out of Phil Bull's research group at the Jodrell Bank Centre for Astrophysics
Expand Down

2 comments on commit fe6e54a

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage

Coverage Report
FileStmtsMissCoverMissing
hydra
   __init__.py30100% 
   beam_sampler.py28725312%32–60, 86–104, 128–147, 181–234, 253–254, 272–274, 279, 297–339, 345–355, 424–475, 500–533, 552–560, 573–577, 609–651, 672–674, 702–711, 729–744, 767–773, 806–830, 846–856, 870–874, 878–896, 948–983, 988–1048
   config.py66635%9–589
   cosmo_sampler.py988216%35–42, 61–74, 101–117, 145–164, 190–194, 213–222, 250–351
   example.py41295%144–164
   gain_sampler.py864647%160–231, 240–301
   linear_solver.py16612227%4, 44–49, 93–137, 174–235, 286–375, 427, 437–439, 459–460, 473–474, 496, 500–501, 504, 508
   plot.py20195%3–41
   ptsrc_sampler.py64395%41, 86, 132
   region_sampler.py640100% 
   sh_sampler.py1917760%141–142, 144–145, 196, 232, 266, 320–325, 376–386, 393–402, 411–448, 456–494, 500–522, 531–535
   sparse_beam.py26123510%69–141, 156–160, 176–187, 204–214, 236–265, 284–316, 340–364, 395–457, 503–577, 580–588, 591–597, 600, 603, 606–609, 612–622, 625–628, 633, 636–638, 641–653
   utils.py20514629%32–35, 49–59, 92–109, 139–155, 190–191, 226–257, 280–287, 306–309, 346–370, 436–457, 489, 519–535, 552–555, 599–617, 628–664, 685–705, 713–734
   vis_sampler.py363114%31–43, 80–104, 152–192
   vis_simulator.py27313252%35–36, 43, 63, 67–72, 88, 97, 176–177, 184, 218, 256–259, 264–267, 270, 278, 313, 398, 403, 410, 416–421, 440, 443, 467, 627–629, 646–647, 663–664, 681, 691–692, 776–863, 921–1053
hydra/tests
   __init__.py00100% 
   test_example.py250100% 
   test_gain_sampler.py190100% 
   test_linear_solver.py220100% 
   test_ptsrc_sampler.py240100% 
   test_region_sampler.py67199%152
   test_sh_sampler.py520100% 
TOTAL2070121241% 

Tests Skipped Failures Errors Time
13 0 💤 0 ❌ 0 🔥 1m 11s ⏱️

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage

Coverage Report
FileStmtsMissCoverMissing
hydra
   __init__.py30100% 
   beam_sampler.py28725312%32–60, 86–104, 128–147, 181–234, 253–254, 272–274, 279, 297–339, 345–355, 424–475, 500–533, 552–560, 573–577, 609–651, 672–674, 702–711, 729–744, 767–773, 806–830, 846–856, 870–874, 878–896, 948–983, 988–1048
   config.py66635%9–589
   cosmo_sampler.py988216%35–42, 61–74, 101–117, 145–164, 190–194, 213–222, 250–351
   example.py41295%144–164
   gain_sampler.py864647%160–231, 240–301
   linear_solver.py16612227%4, 44–49, 93–137, 174–235, 286–375, 427, 437–439, 459–460, 473–474, 496, 500–501, 504, 508
   plot.py20195%3–41
   ptsrc_sampler.py64395%41, 86, 132
   region_sampler.py640100% 
   sh_sampler.py1917760%141–142, 144–145, 196, 232, 266, 320–325, 376–386, 393–402, 411–448, 456–494, 500–522, 531–535
   sparse_beam.py26123510%69–141, 156–160, 176–187, 204–214, 236–265, 284–316, 340–364, 395–457, 503–577, 580–588, 591–597, 600, 603, 606–609, 612–622, 625–628, 633, 636–638, 641–653
   utils.py20514629%32–35, 49–59, 92–109, 139–155, 190–191, 226–257, 280–287, 306–309, 346–370, 436–457, 489, 519–535, 552–555, 599–617, 628–664, 685–705, 713–734
   vis_sampler.py363114%31–43, 80–104, 152–192
   vis_simulator.py27313252%35–36, 43, 63, 67–72, 88, 97, 176–177, 184, 218, 256–259, 264–267, 270, 278, 313, 398, 403, 410, 416–421, 440, 443, 467, 627–629, 646–647, 663–664, 681, 691–692, 776–863, 921–1053
hydra/tests
   __init__.py00100% 
   test_example.py250100% 
   test_gain_sampler.py190100% 
   test_linear_solver.py220100% 
   test_ptsrc_sampler.py240100% 
   test_region_sampler.py67199%152
   test_sh_sampler.py520100% 
TOTAL2070121241% 

Tests Skipped Failures Errors Time
13 0 💤 0 ❌ 0 🔥 1m 38s ⏱️

Please sign in to comment.