# socca


```{epigraph}
/'sɔ.ka/ *noun*

1. A JAX-accelerated Python library for efficiently modelling image-space astronomical data using Bayesian inference.

2. A delicious flatbread made from chickpea flour, water, olive oil, and salt from Nice, France.
```

**``socca``** (*Source Characterization using a Composable Analysis*) is a minimal library for efficiently modelling image-space astronomical data. It is intended to be fast and flexible, taking advantage of the [`JAX`](https://github.com/google/jax) framework for performing just-in-time compilation and of state-of-the-art sampling algorithms ([`dynesty`](https://github.com/joshspeagle/dynesty), [`nautilus`](https://github.com/johannesulf/nautilus), [`pocomc`](https://github.com/minaskar/pocomc), [`emcee`](https://github.com/dfm/emcee)) for the posterior exploration.

This code is broadly inspired by the excellent [`pysersic`](https://github.com/pysersic/pysersic) and [`astrophot`](https://github.com/Autostronomy/AstroPhot) libraries. Their use is recommended if you require a more mature and thoroughly tested solution. **``socca``** is still in its infancy and many experimental features may undergo significant changes in the future. 

[![GitHub](https://img.shields.io/badge/GitHub-lucadimascolo%2Fsocca-blue.svg?style=flat)](https://github.com/lucadimascolo/socca)
[![Python 3.9+](https://img.shields.io/badge/python-3.9%2B-blue.svg)](https://www.python.org/downloads/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![stability-release-candidate](https://img.shields.io/badge/stability-release--candidate-48c9b0.svg)](https://github.com/mkenney/software-guides/blob/master/STABILITY-BADGES.md#release-candidate)
[![ascl:2602.005](https://img.shields.io/badge/ascl-2602.005-blue.svg?colorB=262255)](https://ascl.net/2602.005)<br>
[![CI](https://github.com/lucadimascolo/socca/actions/workflows/ci.yml/badge.svg)](https://github.com/lucadimascolo/socca/actions/workflows/ci.yml)
[![Docs](https://github.com/lucadimascolo/socca/actions/workflows/docs.yml/badge.svg)](https://lucadimascolo.github.io/socca)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![JAX](https://img.shields.io/badge/accelerated%20by-JAX-923CAA)](https://docs.jax.dev/en/latest/index.html)
[![astropy](http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat)](http://www.astropy.org/)

## Where to start?

⚙️ Clearly, first things first: head to the [installation guide](./installation.md) to get the package installed on your system.

🚀 To start using **``socca``**, you can go through the [quickstart tutorial](./tutorials/tutorial_quickstart.md), which will guide you through the main features of the library step by step. For a more in-depth overview of the different functionalities, check out the other guides in the "Using socca" section or the [API reference](./api/index.md).

🐛 Found a bug or have a question? Check out the [contribution guide](./contribute.md) for more information on how to get involved and to contribute to the code development.

📚 Using **``socca``** in your research? Please see the [citation page](./citation.md) for how to cite it in your publications.


## Author and license
Copyright (c) 2024 [Luca Di Mascolo](https://lucadimascolo.github.io) and [contributors](https://github.com/lucadimascolo/socca/graphs/contributors).

**``socca``** is an open-source library released under the MIT License. The full license terms can be found in the [LICENSE](https://github.com/lucadimascolo/socca/blob/main/LICENSE) file in the main repository.

```{toctree}
:hidden:
:maxdepth: 1
:caption: Information
./installation.md
./contribute.md
./citation.md
```

```{toctree}
:hidden:
:maxdepth: 2
:caption: Using socca
./tutorials/tutorial_quickstart.md
./tutorials/tutorial_noise.md
./tutorials/tutorial_data.md
./tutorials/tutorial_models.md
./tutorials/tutorial_priors.md
./tutorials/tutorial_fitting.md
./tutorials/tutorial_plotting.md
./tutorials/tutorial_parallel.md
```

```{toctree}
:hidden:
:maxdepth: 2
:caption: Additional resources
./api/index.md
./faq.md
```