From ac8d0fd37acd7dece14d6a6ca11b7a9f89cdbc14 Mon Sep 17 00:00:00 2001 From: Andrew Chael Date: Wed, 20 May 2020 21:42:14 -0400 Subject: [PATCH] edits to README --- README.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 574cfe80..51804c24 100644 --- a/README.rst +++ b/README.rst @@ -1,7 +1,7 @@ ehtim (eht-imaging) =================== -Python modules for simulating and manipulating VLBI data and producing images with regularized maximum likelihood methods. This version is an early release so please submit a pull request or email achael@cfa.harvard.edu if you have trouble or need help for your application. +Python modules for simulating and manipulating VLBI data and producing images with regularized maximum likelihood methods. This version is an early release so please submit a pull request or email achael@princeton.edu if you have trouble or need help for your application. The package contains several primary classes for loading, simulating, and manipulating VLBI data. The main classes are the ``Image``, ``Movie``, ``Array``, ``Obsdata``, ``Imager``, and ``Caltable`` classes, which provide tools for loading images and data, producing simulated data from realistic u-v tracks, calibrating, inspecting, and plotting data, and producing images from data sets in various polarizations using various data terms and regularizers. @@ -14,7 +14,7 @@ Download the latest version from the `GitHub repository `_, `scipy `_, `matplotlib `_, `astropy `_, `ephem `_, `future `_, `h5py `_ ,`pandas `_ ). +This will install most of the required libraries automatically (`numpy `_, `scipy `_, `matplotlib `_, `astropy `_, `ephem `_, `future `_, `h5py `_, and `pandas `_). **If you want to use fast fourier transforms, you will also need to separately install** `NFFT `_ **and its** `pynfft wrapper `_. The simplest way is to use `conda `__ to install both: @@ -25,7 +25,7 @@ This will install most of the required libraries automatically (`numpy `_, making sure to use the ``--enable-openmp`` flag in compilation. Then install `pynfft `_, with pip, following the readme instructions to link the installation to where you installed NFFT. Finally, reinstall ehtim. -**Certain eht-imaging functions require other external packages that are not automatically installed** In addition to pynfft, these include `networkx `_ (for image comparison functions), `requests `_ (for dynamical imaging), and `scikit-image `_ (for Hough transforms). However, the vast majority of the code will work without these dependencies. +**Certain eht-imaging functions require other external packages that are not automatically installed.** In addition to pynfft, these include `networkx `_ (for image comparison functions), `requests `_ (for dynamical imaging), and `scikit-image `_ (for Hough transforms). However, the vast majority of the code will work without these dependencies. Documentation ------------- @@ -69,7 +69,7 @@ Let us know if you use ehtim in your publication and we'll list it here! - The Size, Shape, and Scattering of Sagittarius A* at 86 GHz: First VLBI with ALMA, `Issaoun et al. 2019 `_ -- First M87 Event Horizon Telescope Results IV: Imaging the Central Supermassive Black HOle, `The Event Horizon Telescope Collaboration 2019 `_ +- First M87 Event Horizon Telescope Results IV: Imaging the Central Supermassive Black Hole, `The Event Horizon Telescope Collaboration 2019 `_ Acknowledgements ----------------