Metadata-Version: 2.4
Name: fomweb
Version: 0.1.2
Summary: Backend for LISA FoM web application
Author-email: Come Badet <come.badet@apc.in2p3.fr>, Maude Le Jeune <lejeune@apc.in2p3.fr>, Yves Lemière <lemiere@lpccaen.in2p3.fr>, Andrea Sartirana <sartirana@apc.in2p3.fr>
Project-URL: Homepage, https://gitlab.in2p3.fr/LISA/fomweb
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# The `fomweb` toolbox

[![DOI](https://zenodo.org/badge/doi/10.5281/zenodo.11504201.svg)](https://zenodo.org/records/11504201)

## Description

This toolbox is a backend for the [LISA science explorer](https://lisa-science-explorer.in2p3.fr) application. It
provides all the tools needed to compute a Figure of Merit (FoM) from
a given LISA noise and mission configuration. Documentation is available [from here](https://lisa.pages.in2p3.fr/fomweb). 

## Installation

We provide an `environment.yml` file giving the list of dependencies.

```
conda env create -f environment.yml
conda activate fomweb
```

## Usage

For each FoM available from the web application, a notebook is
provided in the `notebook` subfolder, illustrating how to:

- Load precomputed data for the baseline LISA configurations; 
- Recompute the data if one wants to change the LISA configuration; 
- Draw the plot associated to a FoM. 

## Support

Report any issue on the [issue board](https://gitlab.in2p3.fr/LISA/fomweb/-/boards) associated to
this project.

## Contributing

Any suggestion to improve on the existing notebooks is more than
welcome (documentation/comments, plot style, etc). Please use the
[issue board](https://gitlab.in2p3.fr/LISA/fomweb/-/boards) or propose [merge request](https://gitlab.in2p3.fr/LISA/fomweb/-/merge_requests). 

LISA experts are also encouraged to contribute to the common tools
source code, or suggest new notebooks through merge request. 
This work is part of the LISA consortium data analysis project named [datard-wg-2025-01](https://directory.lisamission.org/consortium/project/). 

## Authors and acknowledgment

This package is built upon the LISA FoM effort supported by a large panel
of active LISA consortium members. Notebooks and source code
are made public to ease the understanding of the LISA science case and
LISA data analysis to the wide gravitational wave / astro communities.

Please cite the DOI (see badge above) and acknowledge the LISA
consortium in any publication which makes use of it. 

## License

GPL v3.0

