Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
apetri committed Oct 10, 2016
1 parent 41fee76 commit 387e50d
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 10 deletions.
2 changes: 1 addition & 1 deletion HISTORY.rst
Expand Up @@ -3,7 +3,7 @@
0.8
+++

- RayTracer can now perform line of sight integrations to approximate kappa (at Born and post Born 2) and omega (at post Born 2), without full raytracing
- RayTracer can now perform line of sight integrations to approximate kappa (Born, lens-lens and geodesic perturbation) and omega (lens-lens), without full raytracing
- cutPlanes can now handle snapshots in FastPM format
- If snapshots are provided in light cone projections, LensTools can do plane cutting, raytracing and LOS integrations in a single script
- Fit multiple observations with the same FisherAnalysis
Expand Down
6 changes: 3 additions & 3 deletions README.rst
@@ -1,10 +1,10 @@
Welcome to LensTools!
+++++++++++++++++++++

.. image:: https://travis-ci.org/apetri/LensTools.svg?branch=0.8
.. image:: https://travis-ci.org/apetri/LensTools.svg?branch=master
:target: https://travis-ci.org/apetri/LensTools
.. image:: https://coveralls.io/repos/github/apetri/LensTools/badge.svg?branch=0.8
:target: https://coveralls.io/github/apetri/LensTools?branch=0.8
.. image:: https://coveralls.io/repos/github/apetri/LensTools/badge.svg?branch=master
:target: https://coveralls.io/github/apetri/LensTools?branch=master
.. image:: http://img.shields.io/pypi/dm/lenstools.svg?style=flat
:target: https://pypi.python.org/pypi/lenstools/
.. image:: http://img.shields.io/pypi/v/lenstools.svg?style=flat
Expand Down
13 changes: 7 additions & 6 deletions docs/source/index.rst
Expand Up @@ -19,14 +19,15 @@ This python add-on will handle basically every operation you will need to perfor
- Survey masks
- Efficient :math:`E` and :math:`B` mode decompositions of shear maps
- Artificial noise generation engines
- All functionality of pandas_ DataFrame readily available (and improved!)
- Easy to compute parameter statistical inferences
- Easy input/output from :math:`N`-body simulation snapshots in the Gadget2 binary format
- All functionality of pandas_ DataFrame readily available (and improved!) for row-ordered data
- Easy to use statistical methods for parameter sampling
- Easy input/output from :math:`N`-body simulation snapshots in the Gadget2 and FastPM formats
- Interfaces with existing simulation sets
- Ray Tracing simulations
- Ray Tracing simulations: full raytracing, Born approximation, second order post-Born
- Efficient directory tree handling for Weak Lensing simulation pipelines
- CPU vectorization of expensive computations via numpy
- Easy multiprocessing and cluster deployment via the mpi4py_ module
- *Future prospect*: taking advantage of numpy offload capabilities to Intel Xeon Phi coprocessors to boost performance (planned)
- *Future prospect*: take advantage of numpy offload capabilities to Intel Xeon Phi coprocessors to boost performance (planned)

Acknowledgement
---------------
Expand Down Expand Up @@ -100,7 +101,7 @@ Dependencies
.. _NICAEA: http://www.cosmostat.org/software/nicaea/
.. _fftw3: http://www.fftw.org

The core features require the standard numpy_, scipy_ , and additionally astropy_ (mainly for the cosmology and measure units support) and emcee_ (from which LensTools borrows the MPI Pool utility), and the Test suite requires additionally the matplotlib_ package. matpoltlib should eventually be installed if you want to use the plotting engines of LensTools. If you want to use the SQL database querying shortcuts embedded in LensTools, you will need the sqlalchemy_ package too. If you want to run the calculations in parallel on a computer cluster you will need to install mpi4py_ (a python wrapper for the MPI library). Installation of all these packages is advised (if you run astrophysical data analyses you should use them anyway). One of the lenstools features, namely the :py:class:`~lenstools.simulations.Design` class, requires that you have a working version of GSL_ to link to; if you don't have one, just hit *enter* during the installation process and the package will work correctly without this additional feature. The installation if the NICAEA_ bindings additionally requires a working installation of the fftw3_ library.
The core features require the standard numpy_, scipy_ ,pandas_ and additionally astropy_ (mainly for the cosmology and measure units support) and emcee_ (from which LensTools borrows the MPI Pool utility), and the Test suite requires additionally the matplotlib_ package. matpoltlib should eventually be installed if you want to use the plotting engines of LensTools. If you want to use the SQL database querying shortcuts embedded in LensTools, you will need the sqlalchemy_ package too. If you want to run the calculations in parallel on a computer cluster you will need to install mpi4py_ (a python wrapper for the MPI library). Installation of all these packages is advised (if you run astrophysical data analyses you should use them anyway). One of the lenstools features, namely the :py:class:`~lenstools.simulations.Design` class, requires that you have a working version of GSL_ to link to; if you don't have one, just hit *enter* during the installation process and the package will work correctly without this additional feature. The installation if the NICAEA_ bindings additionally requires a working installation of the fftw3_ library.

Test
----
Expand Down

0 comments on commit 387e50d

Please sign in to comment.