A Python package to find a magnetic cloud frame of reference to heliospheric observers using the Minimum Variance approach

Abstract

Describimos el paquete de Python que desarrollamos y que está disponible públicamente para encontrar la orientación de estructuras interplanetarias con características específicas de configuración magnética, denominadas nubes magnéticas(MCs), que permite rotarlas en su marco de referencia local. Adaptamos nuestra previa implementación tipo línea de funciones en Matlab al paradigma Python de programación orientado a objetos. Nuestro fin es proporcionar un paquete fácil de instalar y ejecutar, con un repositorio de código abierto, que brinda estándares de calidad para llegar a una comunidad más amplia de astrofísicos y astrónomos interesados en la heliofísica y la relación Sol-Tierra. Teniendo en cuenta que una nube magnética tiene su propia identidad, estado o atributos y comportamiento (relaciones y métodos), el paradigma de Python es adecuado. Dado que no había librerías o paquetes para encontrar la orientación del eje de una MC implementados en Python y ofrecidos gratuitamente, consideramos nuestro proyecto como una contribución valiosa a la comunidad de heliofísica. En consecuencia, hemos elegido una licencia de Berkeley Software Distribution para su uso, en este artículo se provee información referida a los requerimientos y un breve tutorial para su instalación y uso.

We describe the package we have developed that is publicly available to find the orientation of interplanetary structures, called magnetic clouds (MCs) due to specific characteristics of their magnetic configuration, that allows to rotate them to their local frame. We changed the function pipe-line structure of our Matlab previous implementation to the object-oriented programming Python paradigm to provide a package easy to install and run, with an open source repository. Our aim is to provide an easy to install and execute package with high quality standards to reach a wider community of astrophysicists and astronomers interested in heliophysics and Sun-Earth relationship. Taking into account that a magnetic cloud has its own identity, state or attributes, and behavior (relationships and methods), the Python paradigm is appropriate. Since there were no packages to find the MC axis orientation implemented in Python and freely offered, we regard our project as a valuable contribution to the heliophysics community. Accordingly, we have chosen a Berkeley Software Distribution license for its use, in this article information on the requirements and a brief tutorial for installation and usage are provided.