hoellinger/selfisys_examples
0
0
Fork 0
mirror of https://github.com/hoellin/selfisys_examples.git synced 2025-06-05 15:31:12 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
Examples for the SelfiSys Python package. https://hoellin.github.io/selfisys_public/
1 commit 1 branch 1 tag 3.2 MiB
Find a file
Exact
hoellinger 6992839f10 Initial commit: SelfiSys Examples repository
2025-01-09 17:24:27 +01:00
notebooks Initial commit: SelfiSys Examples repository 2025-01-09 17:24:27 +01:00
CONTRIBUTING.md Initial commit: SelfiSys Examples repository 2025-01-09 17:24:27 +01:00
LICENSE Initial commit: SelfiSys Examples repository 2025-01-09 17:24:27 +01:00
README.md Initial commit: SelfiSys Examples repository 2025-01-09 17:24:27 +01:00

README.md

SelfiSys Examples

arXiv GPLv3 license GitHub version GitHub issues GitHub last commit

This repository provides Jupyter notebooks to explore the SelfiSys Python package for diagnosing systematic effects in spectroscopic galaxy surveys.

Prerequisites

Before using the examples in this repository, ensure that the SelfiSys package is installed. Detailed installation instructions are available in the SelfiSys documentation.

Content

The repository currently includes the following Jupyter notebooks:

  • survey_mask: Generate a survey mask from an external sky map.
  • log-normal: Define custom log-normal radial selection functions.
  • expl_interpolation: Validate the interpolation strategy for representing power spectra.
  • expl_hiddenbox: Implement a hidden-box forward model of a spectroscopic galaxy survey.

Additional examples will be added over time to cover more advanced features and applications.

Requirements

The code depends on the following packages:

  • pySELFI: Python implementation of the Simulator Expansion for Likelihood-Free Inference.
  • Simbelmynë: A hierarchical probabilistic simulator for generating synthetic galaxy survey data.
  • SelfiSys: A software package for diagnosing systematic effects in galaxy surveys.
  • Jupyter Notebook: Required to run the example notebooks.

A comprehensive list of dependencies, including version specifications to ensure reproducibility, will be provided in a yaml file, along with refined installation instructions, in a future release.

Linking to SelfiSys

The examples in this repository are built to work seamlessly with the SelfiSys package. For more information on the core functionality of SelfiSys, refer to:

Getting Started

  1. Clone this repository:

    git clone https://github.com/hoellin/selfisys_examples.git
cd selfisys_examples

  2. Install required dependencies.

  3. Start a Jupyter server in the repository directory:

    jupyter notebook

  4. Open one of the provided notebooks and follow the instructions within.

Contributors

  • Tristan Hoellinger
    tristan.hoellinger@iap.fr
    Principal developer and maintainer, Institut d’Astrophysique de Paris (IAP).

For information on contributing, refer to CONTRIBUTING.md.

License

This software is distributed under the GPLv3 Licence. Please review the LICENSE file in the repository to understand the terms of use and ensure compliance. By downloading and using this software, you agree to the terms of the licence.