From d38743f0be966d6d9d823f5ed075cc13ca500389 Mon Sep 17 00:00:00 2001 From: stefano scardigli <stefano.scardigli@roma2.infn.it> Date: Thu, 18 Apr 2024 17:12:18 +0200 Subject: [PATCH] ...... --- docs/source/aspis_py.rst | 46 +++++++++++++++++++++++----------------- 1 file changed, 26 insertions(+), 20 deletions(-) diff --git a/docs/source/aspis_py.rst b/docs/source/aspis_py.rst index 3df3e70..eeee917 100644 --- a/docs/source/aspis_py.rst +++ b/docs/source/aspis_py.rst @@ -5,24 +5,24 @@ Intro ^^^^^ ASPIS.py is a library of code that allows access to the data contained in ASPIS database and other -various astrophysics community databases, to perform client-side specific analyses of this data and to +various community databases, to perform client-side specific analyses of this data and to visualize it. The data available are of two types: data in the internal database produced by the CAESAR community and information on external data in other databases. Along with access to the data, the ASPIS.py library contains code packages that can be imported as library objects, with which to perform analysis and/or visualization of the data. -The criterion of ASPIS.py is to act as a collector for the data and analysis software of the astrophysics +The criterion of ASPIS.py is to act as a collector for the data and analysis software of the Space Weather (SWx) Italian community and to foster cooperation within the community. In fact, one can use the data and analysis methods developed by the community and, likewise, share one’s own data and methods. Indeed, we have defined a standard template in ASPIS.py for generic data analysis code, and provide a how-to for -developers in the astrophysics community to convert their own code into the standard template, making it +developers in the SWx community to convert their own code into the standard template, making it easily usable for the entire ASPIS.py community in a standard way. In this way ASPIS.py’s primary goal -is to promote collaboration and cooperation within the astrophysics community. It facilitates the sharing +is to promote collaboration and cooperation within the SWx community. It facilitates the sharing of data and analysis methods among researchers, enabling them to benefit from each other’s work. In -summary, ASPIS.py is a tool designed to streamline the access, analysis, and sharing of astrophysical -data and analysis methods within the astrophysics community. It aims to enhance collaboration and +summary, ASPIS.py is a tool designed to streamline the access, analysis, and sharing of +data and analysis methods within the SWx community. It aims to enhance collaboration and standardization, making it easier for researchers to work with and build upon each other’s work in the -field of astrophysics. +field of SWX and astrophysics in general. Functions ^^^^^^^^^^^^^^^^^^ @@ -30,7 +30,7 @@ Functions The functions of the ASPIS.py module are conceived to implement the following key components of the ASPIS service: -1. Access for Advanced Users: ASPIS.py is designed to cater to advanced users in the astrophysics +1. Access for Advanced Users: ASPIS.py is designed to cater to advanced users in the SWx community. It offers a set of functions that can be executed programmatically through a Python interpreter. This capability allows users to perform more complex computations and analysis tasks, surpassing the limitations of a web application. @@ -49,14 +49,14 @@ lessly integrate the functions provided by the module into their own analysis an grams. This promotes flexibility and allows users to tailor their solutions to their research needs. 5. Structured Information in the Database: ASPIS.py relies on structured information within the database. -This information likely includes details about various astrophysical entities such as phenomena, +This information likely includes details about various SWx entities such as phenomena, data descriptions, and chains, which are essential for conducting meaningful analyses. 6. Data Outside the Database: ASPIS.py is designed to work with data that exists outside the database but corresponds to the descriptions available within the database. This flexibility allows researchers to combine data from various sources to enhance their analysis. In summary, ASPIS.py is a versatile tool that caters to both entry-level and advanced users in the -astrophysics community. It provides functions for querying, visualizing, analyzing, and modeling astro- +SWx community. It provides functions for querying, visualizing, analyzing, and modeling astro- physical data. The inclusion of code snippets and use case examples simplifies the usage for a broad range of researchers, and advanced users can extend and customize the functionality to meet their spe- cific research objectives. @@ -69,10 +69,16 @@ installation process may vary depending on the availability and distribution met has to ensure that Python is installed on the system before proceeding. The user can install ASPIS.py using pip, which is the Python package manager: -``sudo -H pip3 install aspis-0.1.7-py3-none-any.whl`` +``mkdir aspispy`` + +``cd aspispy`` + +``curl -get -O https://caesar.iaps.inaf.it/wp-content/uploads/aspispy/aspis-0.2.2-py3-none-any.whl`` + +``sudo -H pip3 install aspis-0.2.2-py3-none-any.whl`` The command is used to install a Python package from a Wheel file (.whl) using pip3 with adminis- -trative privileges (via sudo). The specific package being installed is "aspis-0.1.7-py3-none-any.whl". +trative privileges (via sudo). The specific package being installed is "aspis-0.2.2-py3-none-any.whl". Here’s a breakdown of the command: @@ -80,10 +86,10 @@ Here’s a breakdown of the command: * -H: This flag is used to set the home directory to the target user’s home directory. It can help avoid potential issues with environment variables when using sudo. * pip3: This is the Python package manager for Python 3. * install: It’s the pip command to install packages. -* aspis-0.1.7-py3-none-any.whl: This is Wheel file that you want to install. +* aspis-0.2.2-py3-none-any.whl: This is Wheel file that you want to install. -If everything is set up correctly, running this command install the ASPIS package version 0.1.7 from -the provided Wheel file. +If everything is set up correctly, running this command install the ASPIS package version 0.2.2 from +the provided Wheel file. Note that version number may have changed. Use case example ^^^^^^^^^^^^^^^^ @@ -106,11 +112,11 @@ call the class: compute the CME: -``obj . fit (V0 , sigma_V0 , Time_UTC )`` +``obj . process (V0 , sigma_V0 , Time_UTC )`` compute the CME on target = Earth: -``obj . predict ()`` +``obj . run ()`` plot: @@ -135,7 +141,7 @@ their usage and any additional requirements for proper execution. Code snippets and standardization ................................. -The idea of ASPIS.py is that code developed by different members of the astrophysics community in contiguous +The idea of ASPIS.py is that code developed by different members of the Space Weather community in contiguous fields can be made available to each other and shared in exactly the same way as is usually done with data. In the area of data, standardization of formats and thus the use of databases in which to store information in a consistent and shared manner has been adopted for years. As for software, the situation @@ -143,7 +149,7 @@ is more complex because codes have very heterogeneous characteristics among them groupings still have strong limitations. Inspired by some recent experiences aimed at standardizing the use of codes and comparing the performance of different methods on the same data, ASPIS.py aims to provide a structural scheme with the ability to make the use of code developed by different members of -the astrophysics community for even different purposes available to the entire community. +the Space Weather community for even different purposes available to the entire community. In particular, ASPIS provides four main functions: @@ -179,7 +185,7 @@ All four functions are parameterizable so as to ensure that complex codes that d structures can be framed in the ASPIS system and can therefore perform tasks according to different patterns. The proposed structure is based on the following consideration: advanced methods for data analysis -in the field of astrophysics (and beyond) fall into two main classes: methods supported by a physical +in the field of SWx (and beyond) fall into two main classes: methods supported by a physical model and those that lack it. The former are estimation problems - direct or inverse - for which the "process" function should be implemented as the procedure for solving the inverse problem, meaning that the optimization method that solves the inverse problem should be implemented in this part. In the "run" -- GitLab