Reduce pr template size

.github/pull_request_template.md

@@ -22,42 +22,3 @@ If it fixes an open issue, please link to the issue here. If this PR closes an i
 
 ## Solution Description
 <!-- Please explain the technical solution that I have provided and how it addresses the issue or feature being implemented -->
-
-
-
-## Code Quality
-- [ ] I have read the Contribution Guide
-- [ ] My code follows the code style of this project
-- [ ] My code builds (or compiles) cleanly without any errors or warnings
-- [ ] My code contains relevant comments and necessary documentation
-
-## Project-Specific Pull Request Checklists
-<!--- Please only use the checklist that apply to your change type(s) -->
-
-### Bug Fix Checklist
-- [ ] My fix includes a new test that breaks as a result of the bug (if possible)
-- [ ] My change includes a breaking change
-  - [ ] My change includes backwards compatibility and deprecation warnings (if possible)
-
-### New Feature Checklist
-- [ ] I have added or updated the docstrings associated with my feature using the [NumPy docstring format](https://numpydoc.readthedocs.io/en/latest/format.html)
-- [ ] I have updated the tutorial to highlight my new feature (if appropriate)
-- [ ] I have added unit/End-to-End (E2E) test cases to cover my new feature
-- [ ] My change includes a breaking change
-  - [ ] My change includes backwards compatibility and deprecation warnings (if possible)
-
-### Documentation Change Checklist
-- [ ] Any updated docstrings use the [NumPy docstring format](https://numpydoc.readthedocs.io/en/latest/format.html)
-
-### Build/CI Change Checklist
-- [ ] If required or optional dependencies have changed (including version numbers), I have updated the README to reflect this
-- [ ] If this is a new CI setup, I have added the associated badge to the README
-
-<!-- ### Version Change Checklist [For Future Use] -->
-
-### Other Change Checklist
-- [ ] Any new or updated docstrings use the [NumPy docstring format](https://numpydoc.readthedocs.io/en/latest/format.html).
-- [ ] I have updated the tutorial to highlight my new feature (if appropriate)
-- [ ] I have added unit/End-to-End (E2E) test cases to cover any changes
-- [ ] My change includes a breaking change
-  - [ ] My change includes backwards compatibility and deprecation warnings (if possible)

README.md

@@ -1,50 +1,47 @@
-# fibad
-
+# FIBAD
 [![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/fibad?color=blue&logo=pypi&logoColor=white)](https://pypi.org/project/fibad/)
 [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/lincc-frameworks/fibad/smoke-test.yml)](https://github.com/lincc-frameworks/fibad/actions/workflows/smoke-test.yml)
-[![Codecov](https://codecov.io/gh/lincc-frameworks/fibad/branch/main/graph/badge.svg)](https://codecov.io/gh/lincc-frameworks/fibad)
-[![Read The Docs](https://img.shields.io/readthedocs/fibad)](https://fibad.readthedocs.io/)
-[![Benchmarks](https://img.shields.io/github/actions/workflow/status/lincc-frameworks/fibad/asv-main.yml?label=benchmarks)](https://lincc-frameworks.github.io/fibad/)
+[![codecov](https://codecov.io/gh/lincc-frameworks/fibad/branch/main/graph/badge.svg)](https://codecov.io/gh/lincc-frameworks/fibad)
 
-This project was automatically generated using the LINCC-Frameworks 
-[python-project-template](https://github.com/lincc-frameworks/python-project-template).
+<hr>
 
-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!
+## Introduction
+The **Framework for Image-Based Anomaly Detection** (FIBAD) is an efficient tool
+to hunt for rare and anomalous sources in large astronomical imaging surveys
+(e.g., Rubin-LSST, HSC, Euclid, NGRST, etc.). 
+FIBAD is designed to support four primary steps in the anomaly detection workflow:
 
-For more information about the project template see the 
-[documentation](https://lincc-ppt.readthedocs.io/en/latest/).
+* Downloading large numbers of cutouts from public data repositories
+* Building lower dimensional representations of downloaded images -- the latent space
+* Interactive visualization and algorithmic exploration (e.g., clustering, similarity-search, etc.) of the latent space
+* Identification & rank-ordering of potential anomalous objects
 
-## Dev Guide - Getting Started
+FIBAD is not tied to a specific anomaly detection algorithm/model or a specific
+class of rare/anomalous objects; but rather intended to support any algorithm
+that the user may want to apply on imaging data.
+If the algorithm you want to use takes in tensors, outputs tensors, and can be
+implemented in PyTorch; then chances are FIBAD is the right tool for you!
 
-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.
+## Getting Started 
+To get started with FIBAD, clone the repository and create a new virtual environment.
+If you plan to develop code, run the ``.setup_dev.sh`` script.
 
 ```
->> conda create env -n <env_name> python=3.10
->> conda activate <env_name>
+>> git clone https://github.com/lincc-frameworks/fibad.git
+>> conda create -n fibad python=3.10
+>> bash .setup_dev.sh (Optional, for developers)
 ```
 
-Once you have created a new environment, you can install this project for local
-development using the following commands:
+## Additional Information
+FIBAD is under active development and has limited documentation at the moment.
+We aim to have v1 stability and more documentation in the first half of 2025.
+If you are an astronomer trying to use FIBAD before then, please get in touch with us!
 
-```
->> pip install -e .'[dev]'
->> pre-commit install
->> conda install pandoc
-```
+This project started as a collaboration between different units within the
+[LSST Discovery Alliance](https://lsstdiscoveryalliance.org/) --
+the [LINCC Frameworks Team](https://lsstdiscoveryalliance.org/programs/lincc-frameworks/)
+and LSST-DA Catalyst Fellow, [Aritra Ghosh](https://ghosharitra.com/).
+
+## Acknowledgements
 
-Notes:
-1. The single quotes around `'[dev]'` may not be required for your operating system.
-2. `pre-commit install` 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)
-3. 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)
+This project is supported by Schmidt Sciences.