F311 – collaborative model for Python programmers in Astronomy

Welcome!

Most of the programming work in science is arguably related to loading, saving, visualizing, and manipulating data files somehow. For some, it would be nice a common interface to handle these several data file types.

Project F311 provides a common ground to create new Python packages (herein called collaborator packages) containing new file handling and visualization routines, allowing these file types to be accessed through the explorer.py (Figure 1) application in a plugin-like fashion.

In addition, F311 provide a programs.py scripts that work as an index to all scripts included in all collaborator packages.

By the end of 2017, the following projects were listed as collaborators:

• ariastro (https://github.com/aricorte/ariastro)

• PyFANT (source: https://github.com/trevisanj/pyfant; docs: https://trevisanj.github.io/pyfant)

• AOSSS (source: https://github.com/trevisanj/aosss; docs: https://trevisanj.github.io/aosss)

• F311 itself (source: https://github.com/trevisanj/F311; docs: https://trevisanj.github.io/f311)

Project F311 is a collaborator to itself, providing classes to handle 1D spectral files (such as FITS, “x-y”), and a few scripts as listed below.

Importing the API

The F311 API (application programming interface) can be imported like this:

import f311

Applications (scripts)

The following applications are included in package f311:

• explorer.py: F311 Explorer – file manager-like GUI (graphical user interface) (Figure 1)

• programs.py: Lists all programs available across all collaborators packages

• cut-spectrum.py: Cuts spectrum file to wavelength interval specified

• plot-spectra.py: Plots spectra on screen or creates PDF file

Figure 1 – screenshot of explorer.py.

Acknowledgement

The project started in 2015 at IAG-USP (Institute of Astronomy, Geophysics and Atmospheric Sciences at University of São Paulo, Brazil).

Partially funded by FAPESP - Research Support Foundation of the State of São Paulo, Brazil (2015-2017).

Contents

• F311 Installation
• Index of applications (scripts)
• Collaboration
• Examples
• f311

API Reference

• Index (all symbols listed alphabetically)

• Module Index (whole f311 package tree)

Hint

You can also search using the sidebar box.