omegapy 2.2.11

Python tools for OMEGA/MEx observations analysis

OMEGA-Py : Python tools for OMEGA data

Importation and display of OMEGA/MEx observations in Python 3, based on the IDL SOFT10 routines developped in the IAS planetary team.

Disclaimer: This module is not the official software distributed by the OMEGA team.

Installation & Update

Method 1: from PyPI (recommended)

Installation: pip3 install omegapy

Update: pip3 install omegapy --upgrade

Method 2: from the GitHub repository (development version)

Installation: Clone the repository and install with pip:

git clone https://github.com/AStcherbinine/omegapy.git
cd omegapy
pip3 install .

Update: Go to the previously cloned repository, pull the last updates, and install them with pip:

cd omegapy
git pull
pip3 install .

Configuration

You have to configure the default path of the folders containing the OMEGA binary and omegapy-made files using the environment variables OMEGA_BIN_PATH (for the binary .QUB and .NAV files) and OMEGA_PY_PATH (for the omegapy-made files).

Linux

To do so, add the following lines to your ~/.bashrc (or ~/.zshrc, depending on which shell you are using):

export OMEGA_BIN_PATH="/path/to/binary/files/folder/"
export OMEGA_PY_PATH="/path/to/omegapy-made/files/folder/"

Adapt the path to suit your own architecture.

Tip: You can check that these variables are properly set up by typing the following command in a new terminal: echo $OMEGA_BIN_PATH and echo $OMEGA_PY_PATH. It should print the path you previously set.

MacOS

Similar to the Linux procedure, except that the ~/.bashrc file may not be loaded automatically by default. In that case, use instead ~/.bash_profile.

Note for more recent MacOS versions: The default shell has been changed from bash to zsh in the more recent versions of MacOS. Thus, if you are using a zsh shell, edit the ~/.zshrc file instead of ~/.bash_profile or ~/.bashrc.

Windows (or if you have troubles using the environment variables)

If you are using Windows, you cannot easily set these environment variables. Lucky you, there is a solution!

Note that it also apply if you are using another OS but had troubles setting the environment variables as described above (i.e., you are seeing these warnings when loading omegapy: Warning: $OMEGA_BIN_PATH not defined and/or Warning: $OMEGA_PY_PATH not defined).

In that case, you can set these path directly with Python using the omega_data.set_omega_bin_path() and omega_data.set_omega_py_path() functions. Assuming you have already load omegapy.omega_data as od, simply execute:

od.set_omega_bin_path("/path/to/binary/files/folder/")
od.set_omega_py_path("/path/to/omegapy-made/files/folder/")

Adapt the path to suit your own architecture.

You will have to run these commands everytime you start a new Python console, so I suggest to put these lines at the beginning of your script, just after the omegapy import.

Basic usage

# package importation
import omegapy.omega_data as od
import omegapy.omega_plots as op
import omegapy.useful_functions as uf
# OMEGA file importation (ORB0964_2)
omega = od.OMEGAdata('0964_2')
# Atmospheric correction
omega_corr_atm = od.corr_atm(omega_corr)
# Simultaneous Atmospheric & Thermal corrections (for the use of the L-channel)
# > Use the `npool` argument to control the number of simultaneous processes used to compute the thermal correction 
# > (e.g., npool=15 is usually a nice choice if your system can handle it)
omega_corr_therm_atm = od.corr_therm_atm(omega_corr, npool=1)
# Thermal correction only
omega_corr_therm = od.corr_therm(omega, npool=1)
# Interactive display of the observation (@ λ = 1.085 µm)
op.show_omega_interactif_v2(omega_corr_therm_atm, lam=1.085, cmap='Greys_r', vmin=0, vmax=0.5, polar=True)
# Search for the index of λ = 1.085 µm in the wavelength array
i_lam = uf.where_closer(1.085, omega.lam)

See docs/*.md or the interactive IPython help for more details.

Credits

© Aurélien Stcherbinine (2020–2022)

Institut d'Astrophysique Spatiale (IAS), Université Paris-Saclay, CNRS, Orsay, France

LATMOS/IPSL, UVSQ Université Paris-Saclay, Sorbonne Université, CNRS, Guyancourt, France

License

This package is released under a MIT open source license. See LICENSE for more details.