diff --git a/README.rst b/README.rst index 51ba5a8..fbc2875 100644 --- a/README.rst +++ b/README.rst @@ -1,12 +1,12 @@ .. image:: docs/logo_text.png :scale: 50 -Conduct Fast Radio Burst Population Synthesis | **David Gardenier** | ASTRON +Conduct Fast Radio Burst Population Synthesis | **David Gardenier, Joeri van Leeuwen & Yuyang Wang** | ASTRON & UvA **************** What's frbpoppy? **************** -Establishing the origin and properties of Fast Radio Bursts (FRBs) is one of the biggest goals in radio astronomy. ``frbpoppy`` was called into life to help astronomers determine which FRB properties to expect. Designed to be simple in use and easy to adapt, ``frbpoppy`` continues the work of ``psrpop`` and ``psrpoppy`` in the realm of FRBs. +Establishing the origin and properties of Fast Radio Bursts (FRBs) is one of the biggest goals in radio astronomy. ``frbpoppy`` was called into life to help astronomers determine which FRB properties to expect. Designed to be simple in use and easy to adapt. ********************* How can I install it? @@ -15,7 +15,7 @@ How can I install it? 2. Get the files from the github repository: :: - $ git clone https://github.com/davidgardenier/frbpoppy + $ git clone https://github.com/TRASAL/frbpoppy 3. It's important that frbpoppy is installed locally. Why? It means that you can play around with the code without having to dig into a system wide install. It also allows frbpoppy to create data files more easily. Ubuntu is supported, as should be Macs, however no tests have been done on Windows. Install frbpoppy locally by going to the downloaded directory and running :: @@ -31,12 +31,12 @@ How can I install it? ****************** How do I use it? ****************** -Check out the `examples` directory, the `tests` directory, or else ``frbpoppy``'s `webpage `_! +Check out the `examples` directory or the `tests` directory. **************************************** Which dependencies does `frbpoppy` have? **************************************** -All requirements can be found in `setup.py `_ but are also expanded upon in the following list: +All requirements can be found in `setup.py `_ but are also expanded upon in the following list: - `bokeh >= 1.3.4` for interactive plotting - `numpy >= 1.17.0` for array calculations @@ -57,15 +57,17 @@ And if using an old version of Python (`_ on github, or `contact me `_ directly. Any help is appreciated! +Spotted a bug, or want to add some functionality? Simply `open an issue `_ on github, or `contact Joeri van Leeuwen or Yuyang Wang `_ directly. Any help is appreciated! ******************** Who are the authors? ******************** * **David Gardenier** - As a PhD student at the Netherlands Institute for Radio Astronomy (ASTRON) and the University of Amsterdam (UvA), I'm working with the APERTIF/ALERT team to establish the properties of FRBs. Get in touch with me via `email `_, drop past my `office `_ or say hello at any `FRB conferences `_! + David was a PhD student at the Netherlands Institute for Radio Astronomy (ASTRON) and the University of Amsterdam (UvA), where he worked with the APERTIF/ALERT team to establish the properties of FRBs. He works in industry now drop him a line through `his webpage `_ if you enjoy working with frbpoppy. -***************** -Looking for more? -***************** -Check out ``frbpoppy``'s `webpage `_ for more information! +* **Yuyang Wang** + Yuyang currently persues a PhD student at the University of Amsterdam (UvA) and the Netherlands Institute for Radio Astronomy (ASTRON). His research focusses on FRB population studies and pulsar timing. Get in touch with him via `email `_. + +* **Joeri van Leeuwen** + Joeri is a staff member at the Netherlands Institute for Radio Astronomy (ASTRON) and conceived frbpoppy. Email him at `email `_ or talk to him at a conference. +