https://github.com/yusuke-takase/falcons.jl

Provide pointing calculations for satellites with multiple detectors.
https://github.com/yusuke-takase/falcons.jl

julia

Last synced: about 1 year ago
JSON representation

Provide pointing calculations for satellites with multiple detectors.

• Host: GitHub
• URL: https://github.com/yusuke-takase/falcons.jl
• Owner: yusuke-takase
• License: gpl-3.0
• Created: 2021-05-21T10:22:02.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-12-13T04:39:33.000Z (over 1 year ago)
• Last Synced: 2025-02-20T18:51:26.601Z (over 1 year ago)
• Topics: julia
• Language: Jupyter Notebook
• Homepage:
• Size: 58.6 MB
• Stars: 8
• Watchers: 1
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Falcons



This logo was created with the help of our dear collaborator Jonathan Aumont.

[![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://yusuke-takase.github.io/Falcons.jl/stable)

[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://yusuke-takase.github.io/Falcons.jl/dev)

![Build Status](https://github.com/yusuke-takase/Falcons.jl/actions/workflows/test.yml/badge.svg?branch=master)

Welcome to Falcons(Framework for Astrophysical Locus Computing ON the Sky).

Falcons is a software that rapidly calculates the TOD(Time Ordered Data) of pointing information required for satellite observation simulations.

It supports multi-detectors and can construct a focal plane by specifying (theta,phi) arrays centered on the boresight.

The mapmaking function creates a hitmap and crosslink map from the rapidly obtained time series pointing information.

Falcons is fast enough to run on a laptop, but can be easily used on a supercomputer.

Since the user can specify the amount of memory to occupy according to the available memory on the node, it is very suitable for jobs that are submitted in large quantities.

![Figure](https://user-images.githubusercontent.com/83496454/155742440-294f6b97-1305-43ac-8d57-8534eeab7005.gif)

## Installation

From the Julia REPL, in order to install Falcons from Julia general repository, you can run

```julia

import Pkg

Pkg.add("Falcons")

```

Or you can install the Falcons directory from this GitHub by running

```julia

Pkg> add https://github.com/yusuke-takase/Falcons.jl.git

```

Then, master version is going to be install in your environment.

## Threading

Falcons uses multithreading technology internally when computing pointing TOD. It uses the `@threads` macro provided by Julia, and to use this feature, users need to make the following declarations in the configuration file of the computing environment (ex. `.bashrc`) in advance.

```bash

export JULIA_NUM_THREADS=4

```

In this example, you will use 4 threads. You can change the number of threads according to your computing environment.

## Usage example

See the tutorial [here](https://github.com/yusuke-takase/Falcons.jl/tree/master/tutorial) for details on how to use it.

Refer to the [documentation](https://yusuke-takase.github.io/Falcons.jl/dev/) for more examples.

## How to cite the code

If you use this software, please cite [Y. Takase et al, 2024, JCAP](https://iopscience.iop.org/article/10.1088/1475-7516/2024/12/036) for your publication.