Workspace Tour#

You should have downloaded and configured the autocti workspace when you installed PyAutoCTI.

If you didn’t, checkout the installation instructions for how to downloaded and configure the workspace.

The README.rst files distributed throughout the workspace describe every folder and file, and specify if examples are for beginner or advanced users.

New users should begin by checking out the following parts of the workspace.

Scripts / Notebooks#

There are numerous example describing how to perform ctiing calculations, CTI modeling, and many other PyAutoCTI features. All examples are provided as Python scripts and Jupyter notebooks.

Descriptions of every configuration file and their input parameters are provided in the README.rst in the config directory of the workspace

Config#

Here, you’ll find the configuration files which customize:

  • The default settings used by every non-linear search.

  • Visualization, including the backend used by matplotlib.

  • The priors and notation configs associated with the light and mass profiles used for CTI modeling.

  • The behaviour of different (y,x) Cartesian grids used to perform CTI calculations.

  • The general.ini config which customizes other aspects of PyAutoCTI.

Checkout the configuration section of the readthedocs for a complete description of every configuration file.

Dataset#

Contains the dataset’s used to perform CTI modeling. Example datasets using simulators included with the workspace are included here by default.

Output#

The folder where CTI modeling results are stored.