PyAutoFit Workspace

Installation Guide | readthedocs | Introduction on Binder | HowToFit

Welcome to the PyAutoFit Workspace. You can get started right away by going to the autofit workspace Binder. Alternatively, you can get set up by following the installation guide on our readthedocs.

Getting Started

If you haven't already, install PyAutoFit via pip or conda.

Next, clone the autofit workspace (the line --depth 1 clones only the most recent branch on the autofit_workspace, reducing the download size):

cd /path/on/your/computer/you/want/to/put/the/autofit_workspace
git clone https://github.com/Jammy2211/autofit_workspace --depth 1
cd autofit_workspace

Run the welcome.py script to get started!

python3 welcome.py

Workspace Structure

The workspace includes the following main directories:

notebooks - PyAutoFit examples written as Jupyter notebooks.
scipts - PyAutoFit examples written as Python scripts.
projects - Example projects which use PyAutoFit, which serve as a illustration of model-fitting problems and the PyAutoFit API.
config - Configuration files which customize PyAutoFit's behaviour.
dataset - Where data is stored, including example datasets distributed with PyAutoFit.
output - Where the PyAutoFit analysis and visualization are output.

The examples in the notebooks and scripts folders are structured as follows:

overview - Examples using PyAutoFit to compose and fit a model to data via a non-linear search.
howtofit - Detailed step-by-step tutorials.
model - Model composition cookbooks that offer a concise API reference.
searches - Example scripts of every non-linear search supported by PyAutoFit.
plot - An API reference guide for PyAutoFits's plotting tools.
features - Examples of PyAutoFit's advanced modeling features.

The following projects are available in the project folder:

astro - An Astronomy project which fits images of gravitationally lensed galaxies.

Getting Started

We recommend new users begin with the example notebooks / scripts in the overview folder and the HowToFit tutorials.

Workspace Version

This version of the workspace are built and tested for using PyAutoFit v2021.10.14.1.

Support

Support for installation issues and integrating your modeling software with PyAutoFit is available by raising an issue on the autofit_workspace GitHub page. or joining the PyAutoFit Slack channel, where we also provide the latest updates on PyAutoFit.

Slack is invitation-only, so if you'd like to join send an email requesting an invite.

File	Mode	Size
config
dataset
notebooks
projects
scripts
.gitignore	-rw-r--r--	102 bytes
CITATIONS.rst	-rw-r--r--	811 bytes
CODE_OF_CONDUCT.md	-rw-r--r--	18.4 KB
README.rst	-rw-r--r--	3.7 KB
introduction.ipynb	-rw-r--r--	318.2 KB
requirements.txt	-rw-r--r--	7 bytes
runtime.txt	-rw-r--r--	10 bytes
simulate_datasets_include.sh	-rw-r--r--	0 bytes
simulate_datasets_missing.sh	-rw-r--r--	0 bytes
welcome.py	-rw-r--r--	3.2 KB

README.rst