.. BRAINS documentation master file, created by
   sphinx-quickstart on Thu Jan 31 13:57:41 2019.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Welcome to BRAINS' documentation!
==================================

**B**\ LR **R**\ everberation-mapping **A**\ nalysis **I**\ n AGNs with **N**\ ested **S**\ ampling

A package for dynamically modeling broad-line regions, analyzing reverberation mapping and spectro-astrometric data, 
and measuring the central black hole mass in active galactic nuclei.

Documentation
-------------

.. toctree::
   :maxdepth: 1
   
   getting_started.rst
   param.rst
   output.rst
   data.rst
   mcmc.rst
   resume.rst
   prior.rst
   narrowline.rst
   model.rst
   user_model.rst
   transfun.rst
   sa.rst
   plot.rst
   sim.rst
   mkfile.rst
   todo.rst
   changelog.rst


Attribution
-----------

If using intensity reverberation mapping analysis, please cite our papers

  * `Li, Y.-R., Songshen, Y.-Y., Qiu, J., et al. 2018, ApJ, 869, 137 <http://adsabs.harvard.edu/abs/2018ApJ...869..137L>`_.

  * `Li, Y.-R., Wang, J.-M., Ho, L. C. et al. 2013, ApJ, 779, 110 <http://adsabs.harvard.edu/abs/2013ApJ...779..110L>`_.

If using spectro-astrometric analysis, please cite our papers 
  
  * `Li, Y.-R., Wang, J.-M., Songsheng, Y.-Y. 2022, ApJ, 927, 58 <https://ui.adsabs.harvard.edu/abs/2022ApJ...927...58L/abstract>`_.

  * `Li, Y.-R., Wang, J.-M., Ho, L. C. et al. 2013, ApJ, 779, 110 <http://adsabs.harvard.edu/abs/2013ApJ...779..110L>`_.

If using spectro-astrometric reverberation mapping analysis, please cite our papers 

  * `Li, Y.-R., Wang, J.-M. 2023, ApJ, 943, 36 <https://iopscience.iop.org/article/10.3847/1538-4357/aca66d>`_.
  
  * `Li, Y.-R., Wang, J.-M., Ho, L. C. et al. 2013, ApJ, 779, 110 <http://adsabs.harvard.edu/abs/2013ApJ...779..110L>`_.


Authors & License
-----------------

Copyright 2019 Yan-Rong Li.

Licensed under the `GNU General Public License v3.0 or later <https://opensource.org/licenses/GPL-3.0>`_.

Changelog
---------

see :ref:`log_label`


Indices and Tables
==================

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
