xlens (Graviational Lensing from Image Pixels)

Installation

Github

Users can clone this repository and install the latest package by

git clone https://github.com/mr-superonion/xlens.git
cd xlens
# install required softwares
conda install -c conda-forge --file requirements.txt
# install required softwares for unit tests (if necessary)
conda install -c conda-forge --file requirements_test.txt
pip install . --user

Conda-forge

stable verion can be installed from conda-forge

conda create -c conda-forge --name my_env1
conda install -c conda-forge --file requirements.txt
conda install -c conda-forge xlens

Input Galaxy Catalog

One can download and setup the input CATSIM2017 galaxy catalog:

wget https://github.com/mr-superonion/xlens/releases/download/v0.3.0/catsim-v4.tar.gz

tar xvfz catsim-v4.tar.gz
export CATSIM_DIR=$(realpath catsim-v4)

Examples

Examples can be found here.

Development

Before sending pull request, please make sure that the modified code passed the pytest and flake8 tests. Run the following commands under the root directory for the tests:

flake8
pytest -vv

---

License and Acknowledgements

This project is distributed under the terms of the GNU General Public License version 3. Portions of the codebase originate from the Rubin Observatory Legacy Survey of Space and Time (LSST) Science Pipelines. In accordance with the LSST license requirements, we acknowledge that this product includes software developed by the LSST Project (https://www.lsst.org/). Additional copyright details for bundled LSST-derived software can be found in the accompanying COPYRIGHT file.