Skip to content

Commit

Permalink
📝 Update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
@astrogewgaw
astrogewgaw committed Mar 25, 2024
1 parent 2732e40 commit 8aeb094
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,14 @@

<div align="justify">

As radio waves travel through space, they pass through a lot of ionised gas, or plasma. This plasma acts, in many ways, like a prism; that is, it slows down radio waves at lower frequencies. Thus, radio waves at higher frequencies arrive earlier than those at lower frequencies. These delays introduce a smearing effect into time-domain data. **Dedispersion** is a technique used to undo this smearing effect, allowing us to detect both single and/or periodic pulses from sources such as pulsars, rotational radio transients (or RRATs), and fast radio bursts (or FRBs). `Dedispersion.jl` is a meta-package that brings together packages implementing various dedispersion algorithms in pure Julia. Currently, these are:

* [**`DirectDedispersion.jl`**](https://github.com/astrogewgaw/DirectDedispersion.jl)
* [**`RollingDedispersion.jl`**](https://github.com/astrogewgaw/RollingDedispersion.jl)
* [**`FastDedispersion.jl`**](https://github.com/astrogewgaw/FastDedispersion.jl)

with more packages in development. More information on how to use this package can be found in the documentation of each of the individual packages above. More comprehensive documentation is on the way.

Install it by typing and running:

```bash
Expand All @@ -23,7 +31,6 @@ in the Julia REPL.
</div>

[gitmoji]: https://gitmoji.dev
[presto]: https://github.com/scottransom/presto
[gitmoji_badge]: https://img.shields.io/badge/gitmoji-%20😜%20😍-FFDD67.svg?style=for-the-badge
[stars]: https://img.shields.io/github/stars/astrogewgaw/Dedispersion.jl?style=for-the-badge
[license]: https://img.shields.io/github/license/astrogewgaw/Dedispersion.jl?style=for-the-badge

2 comments on commit 8aeb094

@astrogewgaw
Copy link
Owner Author

Choose a reason for hiding this comment

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

@JuliaRegistrator register()

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

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

Registration pull request updated: JuliaRegistries/General/98689

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.0.1 -m "<description of version>" 8aeb094d3dec1172e969545c9be4bdb9e7dcb9e5
git push origin v0.0.1

Please sign in to comment.