-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #81 from lincc-frameworks/issue/77/readme
Adding/Updating Readme
- Loading branch information
Showing
2 changed files
with
34 additions
and
60 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,50 +1,47 @@ | ||
| # fibad | ||
|
|
||
| # FIBAD | ||
| [](https://lincc-ppt.readthedocs.io/en/latest/) | ||
|
|
||
| [](https://pypi.org/project/fibad/) | ||
| [](https://github.com/lincc-frameworks/fibad/actions/workflows/smoke-test.yml) | ||
| [](https://codecov.io/gh/lincc-frameworks/fibad) | ||
| [](https://fibad.readthedocs.io/) | ||
| [](https://lincc-frameworks.github.io/fibad/) | ||
| [](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. |