A two-channel deconvolution method with Starlet regularization
STARRED: STARlet REgularized Deconvolution
STARlet REgularized Deconvolution (STARRED) is a Python deconvolution method powered by Starlet regularization and JAX automatic differentiation. It uses a Point Spread Function (PSF) narrower than the original one as kernel.
STARRED releases are distributed through the Python Package Index (PyPI). To install the latest version use
$ pip install starred-astro
We provide an Anaconda environment that satisfies all the dependencies in
$ git clone https://gitlab.com/cosmograil/starred.git $ cd starred $ conda env create -f starred-env.yml $ conda activate starred-env $ pip install .
In case you have an NVIDIA GPU, this should automatically download the right version of JAX as well as cuDNN. Next, you can run the tests to make sure your installation is working correctly.
# While still in the STARRED directory: $ pytest .
Manually handling the dependencies
If you want to use an existing environment, just omit the Anaconda commands above:
$ git clone https://gitlab.com/cosmograil/starred $ cd starred $ pip install .
or if you need to install it for your user only:
$ python setup.py install --user
STARRED runs much faster on GPUs, so make sure you install a version of JAX that is compatible with your version of CUDA and cuDNN:
$ pip install "jax[cuda11_cudnn86]" -f https://storage.googleapis.com/jax-releases/jax_cuda_releases.html
STARRED requires the following Python packages:
Example Notebooks and Documentation
We provide several notebooks to help you get started.
More example notebooks going in more detail of how the internals work can be found in the notebooks directory:
- Ground-based narrow PSF generation
- Ground-based joint deconvolution
- Another ground-based joint deconvolution
- JWST PSF generation and deconvolution
- DES2038 joint deconvolution
- HST PSF reconstruction
- JWST PSF reconstruction
You can also run STARRED from the command line by following these instructions.
Finally, the full documentation can be found here.
STARRED is a free software. You can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation.
STARRED is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY, without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details (LICENSE.txt).
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Hashes for starred_astro-1.2.4-py3-none-any.whl