Skip to main content

Fast and flexible astronomical image modelling tool

Project description

<img src=”media/AP_logo.png” alt=”AutoProf” width=”300”/>

AutoProf is a python based astronomical image modelling code. It is highly flexible for a wide range of analysis tasks and uses pytorch to accelerate calculations with automatic exact derivatives and either parallel CPU code, or by taking advantage of GPUs. While pytorch was developped for Machine Learning, AutoProf hijacks its capabilities for regular Chi squared minimization and so is not a Machine Learning tool itself. Written by [Connor Stone](https://connorjstone.com/), AutoProf was developped for a number of science goals such as LSB imaging, handling crowded fields, and dealing with massive volumes of data from the next generation of telescopes. Even if you aren’t pushing these boundaries in particular, you will likely find AutoProf fast and easy to use for any astronomical image modelling task.

## Installation

AutoProf can be pip installed with:

` pip install autoprof `

However, for AutoProf to run you will need to install pytorch as well. Installing pytorch is very user specific, though also not very hard. Follow the instructions on the [pytorch website](https://pytorch.org/) to install a version for your system.

Also note that AutoProf is only available for python3.

## Getting started

The easiest way to get started using AutoProf is to try running the jupyter notebook tutorials. Simply make a new directory where you want to run the tutorials then run the:

` autoprof tutorials `

command to download the AutoProf tutorials. If you run into difficulty with this, you can also access the tutorials directly at [this link](https://github.com/ConnorStoneAstro/AutoProf-2/tree/main/docs/tutorials) to download. Once you have the tutorials, start a jupyter session and run through them. The recommended order is:

1. GettingStarted 1. CombinedModels 1. ModelZoo

## Documentation

Further documentation is in development. In the meantime you can contact the author [Connor Stone](https://connorjstone.com/) for any questions not answered by the tutorials.

## Credit / Citation

If you use AutoProf in your research, please credit the author by citing: [ADS Bibliographic Record](https://ui.adsabs.harvard.edu/abs/2021MNRAS.508.1870S/abstract). A new paper for the updated AutoProf code is in the works.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

autoprof-0.1.3-py2.py3-none-any.whl (98.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file autoprof-0.1.3-py2.py3-none-any.whl.

File metadata

  • Download URL: autoprof-0.1.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 98.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.8.10

File hashes

Hashes for autoprof-0.1.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 215ff75c983bae6170799a0b712138c33b23441dd1b4c6ae85dbdf07f89a0174
MD5 b671fc9bc67cabf92839a25ee1b6c099
BLAKE2b-256 72d997679d470f7457f7d2ed5b057835631ee8a3c1f55db83f574f71ab13f05d

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page