From dc36daed5c551b9004f4467589a5bfe998161b6d Mon Sep 17 00:00:00 2001 From: Andrew Chael Date: Thu, 10 Dec 2020 01:00:24 -0500 Subject: [PATCH] Update README.rst --- README.rst | 26 ++++++++++++++++++++------ 1 file changed, 20 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index df8d68d2..d1fcd569 100644 --- a/README.rst +++ b/README.rst @@ -1,9 +1,9 @@ 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@princeton.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 raise an issue, 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. +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 regularizing functions. Installation @@ -15,7 +15,7 @@ The latest stable version (`1.2.1 `_. To use the very latest (unstable) code, checkout dev, change to the main eht-imaging directory, and run: +Incremental updates are developed on the `dev branch `_. To use the very latest (unstable) code, checkout the dev branch, change to the main eht-imaging directory, and run: .. code-block:: bash @@ -46,7 +46,7 @@ A full tutorial is in progress, but here are some ways to learn to use the code: Some publications that use ehtim -------------------------------- -If you use ehtim in your publication, please cite both `Chael+ 2016 `_ and `Chael+ 2018 `_ +If you use ehtim in your publication, please cite `Chael+ 2018 `_ Let us know if you use ehtim in your publication and we'll list it here! @@ -56,8 +56,6 @@ Let us know if you use ehtim in your publication and we'll list it here! - Stochastic Optics: A Scattering Mitigation Framework for Radio Interferometric Imaging, `Johnson 2016 `_ -- Quantifying Intrinsic Variability of Sgr A* using Closure Phase Measurements of the Event Horizon Telescope, `Roelofs et al. 2017 `_ - - Reconstructing Video from Interferometric Measurements of Time-Varying Sources, `Bouman et al. 2017 `_ - Dynamical Imaging with Interferometry, `Johnson et al. 2017 `_ @@ -78,6 +76,22 @@ Let us know if you use ehtim in your publication and we'll list it here! - First M87 Event Horizon Telescope Results IV: Imaging the Central Supermassive Black Hole, `The Event Horizon Telescope Collaboration 2019 `_ +- VLBI Imaging of black holes via second moment regularization, `Issaoun et al. 2019 `_ + +- Using evolutionary algorithms to model relativistic jets: Application to NGC 1052, `Fromm et al. 2019 `_ + +- EHT-HOPS Pipeline for Millimeter VLBI Data Reduction, `Blackburn et al. 2019 `_ + +- Multi-wavelength torus-jet model for Sagittarius A*, `Vincent et al. 2019 `_ + +- Discriminating Accretion States via Rotational Symmetry in Simulated Polarimetric Images of M87, `Palumbo et al. 2020 `_ + +- SYMBA: An end-to-end VLBI synthetic data generation pipeline. Simulating Event Horizon Telescope observations of M87, `Roelofs et al. 2020 `_ + +- Monitoring the Morphology of M87* in 2009-2017 with the Event Horizon Telescope, `Wielgus et al. 2020 `_ + +- EHT imaging of the archetypal blazar 3C 279 at extreme 20 microarcsecond resolution, `Kim et al. 2020 `_ + Acknowledgements ---------------- The oifits_new code used for reading/writing .oifits files is a slightly modified version of Paul Boley's package at ``_. The oifits read/write functionality is still being developed and may not work with all versions of python or astropy.