Update README.md with link to getting started for Julia projects

[SamuelBrand1]

As per title.

Closes #312

[github-actions]

Benchmark result

Judge result

Benchmark Report for /home/runner/work/Rt-without-renewal/Rt-without-renewal

Job Properties

• Time of benchmarks:
  • Target: 28 Jun 2024 - 12:28
  • Baseline: 28 Jun 2024 - 12:28
• Package commits:
  • Target: 5ae2d8
  • Baseline: d7f3b6
• Julia commits:
  • Target: 48d4fd
  • Baseline: 48d4fd
• Julia command flags:
  • Target: None
  • Baseline: None
• Environment variables:
  • Target: None
  • Baseline: None

Results

A ratio greater than 1.0 denotes a possible regression (marked with ❌), while a ratio less
than 1.0 denotes a possible improvement (marked with ✅). Only significant results - results
that indicate possible regressions or improvements - are shown below (thus, an empty table means that all
benchmark results remained invariant between builds).

ID	time ratio	memory ratio

Benchmark Group List

Here's a list of all the benchmark groups executed by this job:

• ["EpiAwareUtils"]

Julia versioninfo

Target

Julia Version 1.10.4
Commit 48d4fd48430 (2024-06-04 10:41 UTC)
Build Info:
  Official https://julialang.org/ release
Platform Info:
  OS: Linux (x86_64-linux-gnu)
      Ubuntu 22.04.4 LTS
  uname: Linux 6.5.0-1022-azure #23~22.04.1-Ubuntu SMP Thu May  9 17:59:24 UTC 2024 x86_64 x86_64
  CPU: AMD EPYC 7763 64-Core Processor: 
              speed         user         nice          sys         idle          irq
       #1  2445 MHz       2317 s          0 s        241 s       3095 s          0 s
       #2  3167 MHz       2467 s          0 s        245 s       2859 s          0 s
       #3  3253 MHz       2506 s          0 s        238 s       2900 s          0 s
       #4  3240 MHz       2304 s          0 s        225 s       3062 s          0 s
  Memory: 15.606491088867188 GB (14081.328125 MB free)
  Uptime: 582.91 sec
  Load Avg:  2.55  2.64  1.27
  WORD_SIZE: 64
  LIBM: libopenlibm
  LLVM: libLLVM-15.0.7 (ORCJIT, znver3)
Threads: 1 default, 0 interactive, 1 GC (on 4 virtual cores)

Baseline

Julia Version 1.10.4
Commit 48d4fd48430 (2024-06-04 10:41 UTC)
Build Info:
  Official https://julialang.org/ release
Platform Info:
  OS: Linux (x86_64-linux-gnu)
      Ubuntu 22.04.4 LTS
  uname: Linux 6.5.0-1022-azure #23~22.04.1-Ubuntu SMP Thu May  9 17:59:24 UTC 2024 x86_64 x86_64
  CPU: AMD EPYC 7763 64-Core Processor: 
              speed         user         nice          sys         idle          irq
       #1  2445 MHz       2384 s          0 s        245 s       3160 s          0 s
       #2  2445 MHz       2517 s          0 s        249 s       2941 s          0 s
       #3  3242 MHz       2520 s          0 s        241 s       3020 s          0 s
       #4  3236 MHz       2306 s          0 s        226 s       3195 s          0 s
  Memory: 15.606491088867188 GB (14057.3203125 MB free)
  Uptime: 596.59 sec
  Load Avg:  2.2  2.56  1.27
  WORD_SIZE: 64
  LIBM: libopenlibm
  LLVM: libLLVM-15.0.7 (ORCJIT, znver3)
Threads: 1 default, 0 interactive, 1 GC (on 4 virtual cores)

---

Target result

Benchmark Report for /home/runner/work/Rt-without-renewal/Rt-without-renewal

Job Properties

• Time of benchmark: 28 Jun 2024 - 12:28
• Package commit: 5ae2d8
• Julia commit: 48d4fd
• Julia command flags: None
• Environment variables: None

Results

Below is a table of this job's results, obtained by running the benchmarks.
The values listed in the ID column have the structure [parent_group, child_group, ..., key], and can be used to
index into the BaseBenchmarks suite to retrieve the corresponding benchmarks.
The percentages accompanying time and memory values in the below table are noise tolerances. The "true"
time/memory value for a given benchmark is expected to fall within this percentage of the reported value.
An empty cell means that the value was zero.

ID	time	GC time	memory	allocations
["EpiAwareUtils", "censored_pmf"]	1.101 μs (5%)		352 bytes (1%)	4

Benchmark Group List

Here's a list of all the benchmark groups executed by this job:

• ["EpiAwareUtils"]

Julia versioninfo

Julia Version 1.10.4
Commit 48d4fd48430 (2024-06-04 10:41 UTC)
Build Info:
  Official https://julialang.org/ release
Platform Info:
  OS: Linux (x86_64-linux-gnu)
      Ubuntu 22.04.4 LTS
  uname: Linux 6.5.0-1022-azure #23~22.04.1-Ubuntu SMP Thu May  9 17:59:24 UTC 2024 x86_64 x86_64
  CPU: AMD EPYC 7763 64-Core Processor: 
              speed         user         nice          sys         idle          irq
       #1  2445 MHz       2317 s          0 s        241 s       3095 s          0 s
       #2  3167 MHz       2467 s          0 s        245 s       2859 s          0 s
       #3  3253 MHz       2506 s          0 s        238 s       2900 s          0 s
       #4  3240 MHz       2304 s          0 s        225 s       3062 s          0 s
  Memory: 15.606491088867188 GB (14081.328125 MB free)
  Uptime: 582.91 sec
  Load Avg:  2.55  2.64  1.27
  WORD_SIZE: 64
  LIBM: libopenlibm
  LLVM: libLLVM-15.0.7 (ORCJIT, znver3)
Threads: 1 default, 0 interactive, 1 GC (on 4 virtual cores)

---

Baseline result

Benchmark Report for /home/runner/work/Rt-without-renewal/Rt-without-renewal

Job Properties

• Time of benchmark: 28 Jun 2024 - 12:28
• Package commit: d7f3b6
• Julia commit: 48d4fd
• Julia command flags: None
• Environment variables: None

Results

Below is a table of this job's results, obtained by running the benchmarks.
The values listed in the ID column have the structure [parent_group, child_group, ..., key], and can be used to
index into the BaseBenchmarks suite to retrieve the corresponding benchmarks.
The percentages accompanying time and memory values in the below table are noise tolerances. The "true"
time/memory value for a given benchmark is expected to fall within this percentage of the reported value.
An empty cell means that the value was zero.

ID	time	GC time	memory	allocations
["EpiAwareUtils", "censored_pmf"]	1.095 μs (5%)		352 bytes (1%)	4

Benchmark Group List

Here's a list of all the benchmark groups executed by this job:

• ["EpiAwareUtils"]

Julia versioninfo

Julia Version 1.10.4
Commit 48d4fd48430 (2024-06-04 10:41 UTC)
Build Info:
  Official https://julialang.org/ release
Platform Info:
  OS: Linux (x86_64-linux-gnu)
      Ubuntu 22.04.4 LTS
  uname: Linux 6.5.0-1022-azure #23~22.04.1-Ubuntu SMP Thu May  9 17:59:24 UTC 2024 x86_64 x86_64
  CPU: AMD EPYC 7763 64-Core Processor: 
              speed         user         nice          sys         idle          irq
       #1  2445 MHz       2384 s          0 s        245 s       3160 s          0 s
       #2  2445 MHz       2517 s          0 s        249 s       2941 s          0 s
       #3  3242 MHz       2520 s          0 s        241 s       3020 s          0 s
       #4  3236 MHz       2306 s          0 s        226 s       3195 s          0 s
  Memory: 15.606491088867188 GB (14057.3203125 MB free)
  Uptime: 596.59 sec
  Load Avg:  2.2  2.56  1.27
  WORD_SIZE: 64
  LIBM: libopenlibm
  LLVM: libLLVM-15.0.7 (ORCJIT, znver3)
Threads: 1 default, 0 interactive, 1 GC (on 4 virtual cores)

---

Runtime information

Runtime Info
BLAS #threads	2
BLAS.vendor()	lbt
Sys.CPU_THREADS	4

lscpu output:

Architecture:                       x86_64
CPU op-mode(s):                     32-bit, 64-bit
Address sizes:                      48 bits physical, 48 bits virtual
Byte Order:                         Little Endian
CPU(s):                             4
On-line CPU(s) list:                0-3
Vendor ID:                          AuthenticAMD
Model name:                         AMD EPYC 7763 64-Core Processor
CPU family:                         25
Model:                              1
Thread(s) per core:                 2
Core(s) per socket:                 2
Socket(s):                          1
Stepping:                           1
BogoMIPS:                           4890.85
Flags:                              fpu vme de pse tsc msr pae mce cx8 apic sep mtrr pge mca cmov pat pse36 clflush mmx fxsr sse sse2 ht syscall nx mmxext fxsr_opt pdpe1gb rdtscp lm constant_tsc rep_good nopl tsc_reliable nonstop_tsc cpuid extd_apicid aperfmperf pni pclmulqdq ssse3 fma cx16 pcid sse4_1 sse4_2 movbe popcnt aes xsave avx f16c rdrand hypervisor lahf_lm cmp_legacy svm cr8_legacy abm sse4a misalignsse 3dnowprefetch osvw topoext invpcid_single vmmcall fsgsbase bmi1 avx2 smep bmi2 erms invpcid rdseed adx smap clflushopt clwb sha_ni xsaveopt xsavec xgetbv1 xsaves clzero xsaveerptr rdpru arat npt nrip_save tsc_scale vmcb_clean flushbyasid decodeassists pausefilter pfthreshold v_vmsave_vmload umip vaes vpclmulqdq rdpid fsrm
Virtualization:                     AMD-V
Hypervisor vendor:                  Microsoft
Virtualization type:                full
L1d cache:                          64 KiB (2 instances)
L1i cache:                          64 KiB (2 instances)
L2 cache:                           1 MiB (2 instances)
L3 cache:                           32 MiB (1 instance)
NUMA node(s):                       1
NUMA node0 CPU(s):                  0-3
Vulnerability Gather data sampling: Not affected
Vulnerability Itlb multihit:        Not affected
Vulnerability L1tf:                 Not affected
Vulnerability Mds:                  Not affected
Vulnerability Meltdown:             Not affected
Vulnerability Mmio stale data:      Not affected
Vulnerability Retbleed:             Not affected
Vulnerability Spec rstack overflow: Vulnerable: Safe RET, no microcode
Vulnerability Spec store bypass:    Vulnerable
Vulnerability Spectre v1:           Mitigation; usercopy/swapgs barriers and __user pointer sanitization
Vulnerability Spectre v2:           Mitigation; Retpolines; STIBP disabled; RSB filling; PBRSB-eIBRS Not affected; BHI Not affected
Vulnerability Srbds:                Not affected
Vulnerability Tsx async abort:      Not affected

Cpu Property	Value
Brand	AMD EPYC 7763 64-Core Processor
Vendor	:AMD
Architecture	:Unknown
Model	Family: 0xaf, Model: 0x01, Stepping: 0x01, Type: 0x00
Cores	16 physical cores, 16 logical cores (on executing CPU)
	No Hyperthreading hardware capability detected
Clock Frequencies	Not supported by CPU
Data Cache	Level 1:3 : (32, 512, 32768) kbytes
	64 byte cache line size
Address Size	48 bits virtual, 48 bits physical
SIMD	256 bit = 32 byte max. SIMD vector size
Time Stamp Counter	TSC is accessible via rdtsc
	TSC runs at constant rate (invariant from clock frequency)
Perf. Monitoring	Performance Monitoring Counters (PMC) are not supported
Hypervisor	Yes, Microsoft

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.18%. Comparing base (d7f3b69) to head (9fdf1bf).

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #313   +/-   ##
=======================================
  Coverage   93.18%   93.18%           
=======================================
  Files          50       50           
  Lines         528      528           
=======================================
  Hits          492      492           
  Misses         36       36           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[seabbs]

Looks good. One comment that is a potential new issue.