update README

# lsst_agile

# AGILE: AGNs In the LSST Era

#

[![Template](https://img.shields.io/badge/Template-LINCC%20Frameworks%20Python%20Project%20Template-brightgreen)](https://lincc-ppt.readthedocs.io/en/latest/)

[![PyPI](https://img.shields.io/pypi/v/lsst_agile?color=blue&logo=pypi&logoColor=white)](https://pypi.org/project/lsst_agile/)

[![Read The Docs](https://img.shields.io/readthedocs/lsst-agile)](https://lsst-agile.readthedocs.io/)

[![Benchmarks](https://img.shields.io/github/actions/workflow/status/INAF-OAR/lsst_agile/asv-main.yml?label=benchmarks)](https://INAF-OAR.github.io/lsst_agile/)

This project was automatically generated using the LINCC-Frameworks 

[python-project-template](https://github.com/lincc-frameworks/python-project-template).

A repository badge was added to show that this project uses the python-project-template, however it's up to

you whether or not you'd like to display it!

For more information about the project template see the 

[documentation](https://lincc-ppt.readthedocs.io/en/latest/).

## Dev Guide - Getting Started

Before installing any dependencies or writing code, it's a great idea to create a

virtual environment. LINCC-Frameworks engineers primarily use `conda` to manage virtual

environments. If you have conda installed locally, you can run the following to

create and activate a new environment.

```

>> conda create -n <env_name> python=3.11

>> conda activate <env_name>

```

Once you have created a new environment, you can install this project for local

development using the following commands:

```

>> ./.setup_dev.sh

>> conda install pandoc

```

Notes:

1. `./.setup_dev.sh` will initialize pre-commit for this local repository, so

   that a set of tests will be run prior to completing a local commit. For more

   information, see the Python Project Template documentation on 

   [pre-commit](https://lincc-ppt.readthedocs.io/en/latest/practices/precommit.html)

2. Install `pandoc` allows you to verify that automatic rendering of Jupyter notebooks

   into documentation for ReadTheDocs works as expected. For more information, see

   the Python Project Template documentation on

   [Sphinx and Python Notebooks](https://lincc-ppt.readthedocs.io/en/latest/practices/sphinx.html#python-notebooks)

AGILE is an end-to-end simulation pipeline designed to simulate truth catalogs

as well as realistic LSST-like images, and photometric catalogs of AGNs,

galaxies, and stars. AGILE is developed by INAF-OAR and in close collaboration

with the Rubin-LSST AGN Science Collaboration.

This repository hosts the source code for AGILE. For documentation, please

refer to the links below.

## Links

- Documentation

        - User guide

                - Introduction

                - Installation

                - Usage

        - Notebooks

                - Using AGILE

                        - Create a truth catalog

                        - Create lightcurves

                        - Simulate images

                        - Analyze simulated images

                - Using AGILE data products

                        - Analyzing catalogs

                        - Analyzing SEDs

                        - Analyzing lightcurves

                        - Analyzing images

                        - Comparing to DP1

        - API reference

- Development

## Literature

Viitanen+2026, A&A submitted

## Credits

- Akke Viitanen, development lead

- Angela Bongiorno, project lead,

- Ivano Saccheo, AGN SEDs

- Daniel Roberts, MBH module

- Vincenzo Petrecca, AGN lightcurve module

- Giulia De Somma, Cepheid lightcurve module