pablomsanala / astropipe Goto Github PK

AstroPipe is a pipeline aim to produce reliable surface brightness profiles of galaxies. It has built-in functions to reduce, analyse and visualize astronomical images in general. It is meant to help me analyse all the data for my PhD and being able to share it with other colleagues.
This is a work in progress, use at your own risk!
Explore the docs »

View Demo · Report Bug · Request Feature

All this code is the result of my Ph.D. The aim of this "library" is to help analyse astronomical images. More specifically, to obtain reliable surface brightness profiles. It can also offer more features to reduce, smooth, fit, and visualize images. It is written in Python and mostly uses common libraries (see the prerequisites).

(back to top)

Since this is a multiple-purpose library it depends on different Python libraries and astronomical software. It also depends on the modules you would like to use. Here I explained briefly the biggest dependencies of the different modules.

To use the masking module you need to have different external software for Astronomical Image Segmentation. Specifically the following software:

• SExtractor
• Gnuastro
• MTObjects

and the aliases need to be stored in your environment variable so you can call the different software. In particular, for Gnuastro, it uses NoiseChisel. This needs to be installed if you want to create masks. However there are different methods that use different software, so it's not mandatory to have all installed but at least, one of them.

The library is written in Python and uses different libraries. Most of them can be installed using pip. You can find the main requisites in the requirements.txt. Furthermore, you must install the sewpy library apart from the ones installed automatically with the requirements.txt file.

You can install the library using pip as follows:

  git clone https://github.com/PabloMSanAla/AstroPipe.git
  cd AstroPipe
  pip install -e .

I strongly recommend to install it in a separate virtual environment. You could also add this to your Python path in this repository and you would not depend on pip.

(back to top)

Work in progress...

I created different Jupyter notebooks to help you use the pipeline and get a sense of the methods built-in.

• Cavity: Jupyter Notebook to create masks, profiles and visualize galaxies from a CAVITY field.

(back to top)

Contributions are what makes the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Distributed under the GNU General Public License. See LICENSE.txt for more information.

(back to top)

Pablo M Sánchez-Alarcón - [email protected]

Project Link: https://github.com/PabloMSanAla/AstroPipe

(back to top)

Thank you for using AstroPipe.

(back to top)

Readme file taken from Best README Template.