diff --git a/docs/source/aspis.rst b/docs/source/aspis.rst index 3feb50a5c3cec7452c4d135b6e12abc9e27b5956..1ac275838fa288aac4c754ce54c64b8bb2c00f75 100644 --- a/docs/source/aspis.rst +++ b/docs/source/aspis.rst @@ -1,6 +1,50 @@ ASPIS ==== +The Italian Space Agency has produced a Space Weather (SWE) roadmap **([RD-2])** for a long-term strategy to +support the future scientific research of SWE, and the development of a related national scientific data centre +for Space Weather, called ASI SPace Weather InfraStructure (ASPIS), while reinforcing the interactions and +synergies among the SWE Italian groups, and organizing them in a strong collaborative environment. +The ASPIS system is hosted in the ASI SSDC infrastructure. + +.. image:: assets/images/logo_ASPIS_prtscrn.png + :height: 320 + :align: center + :alt: Alternative text + +ASPIS for science +----------------- + +From a scientific point of view, ASPIS addresses problems related to the origin and evolution of solar eruptive +events, their propagation and impacts through an unprecedented, comprehensive, multidisciplinary, and +integrated approach. This encompasses the whole chain of phenomena from the Sun to the Earth, as well as +to other planets. In this endeavour, it will be crucial to exploit a variety of products (datasets, codes, models), +which ultimately populate the ASPIS system. ASPIS unifies multiple SWE resources in a flexible +architecture to allow users to perform advanced scientific studies, both through a web interface, and a dedicated +SW package called ASPIS.py. A keyword, metadata-based system enhances search capabilities, especially as +data volume grows with recorded events. The ASPIS system is open-source, allowing researchers to +study problems that span across disciplinary boundaries. It creates an environment where scientists can +discover, understand, and model the connection between solar phenomena, interplanetary disturbances, and +their impacts on the planets (especially the Earth). + +ASI-SSDC context +------------ + +The Space Science Data Center of the Italian Space Agency has its roots in the early ’90s with the Data Center of +the BeppoSax X-ray astronomy satellite, then evolved into the ASI Science Data Center (ASDC), established in +2000 as a multi-mission facility linked to high-energy astrophysics data managing and exploitation. +The two distinctive scopes of SSDC are the archiving, analysis, distribution of space mission data, and the +development of scientific tools to extract high-level scientific information from the data of interest. These goals +have been traditionally accomplished by following an “operative approach” involving both scientists and +industrial partners. The centre is constituted by personnel from the Italian Space Agency, the National Institute +for Astrophysics (INAF), and the National Institute for Nuclear Physics (INFN), with an Information and +Communication Technology (ICT) support provided by industrial partners (that currently are Telespazio and +Serco). +This approach allowed for the development of software tools oriented to the real scientists needs. Indeed, some +of these tools have become milestones for the relevant scientific communities, such as the Multi Mission +Interactive Archive (MMIA), the SED (Spectral Energy Distribution) Tool and MATISSE. + + .. toctree:: :caption: ASPIS documentation diff --git a/docs/source/aspis/webapp.rst b/docs/source/aspis/webapp.rst index 55d4fd83b1f59e6ea7716a90a0c1c949dad36502..8e842eb8594859064c7a12702496744e28dfb68d 100644 --- a/docs/source/aspis/webapp.rst +++ b/docs/source/aspis/webapp.rst @@ -5,9 +5,71 @@ Web Application Intro ^^^^^^^ -A intro describing webapplication - +ASPIS webapp aims to provide an easy, user friendly, access to the data contained in the DATABASE. +ASPIS webapp will be suited with tools able to easy access and visualize data. Technically, ASPIS +web-app will access to database using a set of dedicated API (GET) who will act as middleware to the +Database queries. A key feature will be the function to visualize several data-set in the same page. The +feature, strongly related to the casual-chain [ref. 1] concept is designed to take into account the standard +work-flow of the Space Weather community while they are inspecting correlation and liked phenomena +inside different products. A small and protected amount of server-side and/or client side models should +be run over visualized data for simple and light computation, notwithstanding the intention of the web-app +is to facilitate the data exploration and cross-visualization. Users will be encouraged to implement heavy +computations and advanced data handling using ASPIS.py [ref. 9] libraries. Functionalities -^^^^^^^ +^^^^^^^^^^^^^^^ + +The web-app will be accessible using a common web browser. Basic functionalities are expected to be +public and will be open to the community: + +• Search in the archive based on several keys +• Time based queries +• Spatial queries +• Data visualization +• Data comparison (Multiple plots) +• Access to the Causal-chains +• Causal-chain visualization with multiple plots. +• Quick citation extraction tools based on visualized data. +Advanced functionalities will be protected and will be accessible only to user identification: +• Save search results +• Save data visualization settings +• Run internal, server-side, ASPIS models over an identified data-set +• (optional) Light computation of model and data comparison +The Access Control List (ACL) will be provided by the ASPIS machines (Fig. 5) + +Time-based multi-plot visualization +................................... + +Time is a key link between the most of data-sets provided. So, graphical representation of data shall be +able to facilitate a time-based comparison between the series visualized by a common timeline. In this +way, every relationship between time-based plots can be easily found by the user. + +Spatial visualization +..................... + +Data-set are generated by instruments spatially referenced by acquisition site (ex. the instrument is +physically mounted on a Spacecraft or on Earth ), by target position (ex. The instrument target is the +Sun) and by line of sight (ex. the instrument acquire 20 square deg in a direction of the sky). This info +can be used to facilitate the user to visualize: +• Instruments positions in a specified time span +• Targets positions in a specified time span +• Targets coverage in instruments line of sights. +• Visualization of specific phenomena in different reference systems + +Event-chain visualization +......................... + +Causal-chains (ref. 1) will get a special section in the webapp. Causal-chains will take advantage from the +other basic visualization plots and can be associated here as a pre-defined organization of data subsets +plots. Web-app dedicated section will be able to list and search all causal-chains. Web-app will be able +to advise the user if, in a nominal visualization plot, the data subset is part of a know causal-chain and +propose a suitable visualization of such a causal-chain. + +Data proximity suggestions +.......................... + +User would be prompt by the system in case other data-sets, respect to ones already visualized, will +have a "proximity" (in terms of observed target, data coherence, data meaning, spatial nearness ) and +are available in the ASPIS Database system for the observed time-span or in a relevant subsequent time +(to consider propagation of the phenomena to other instruments). diff --git a/docs/source/caesar.rst b/docs/source/caesar.rst index 31f1d1494e361e937b92e90c92a2cccf39e0b918..3e17de7964bfac6a3a57ce034ebe26a18348d6b5 100644 --- a/docs/source/caesar.rst +++ b/docs/source/caesar.rst @@ -40,4 +40,14 @@ The CAESAR_ project is structured in such a way as to cover all the fundamental CAESAR_ involves over 75 scientists from Universities and Research Bodies throughout Italy (University of Rome Tor Vergata, University of Catania, University of Genoa, University of Calabria, University of Trento, University of L'Aquila, University of Perugia, ASI, INAF, National Institute of Nuclear Physics, National Institute of Geophysics and Vulcanonlogy), as well as personnel belonging to some international research centers. This is a very important opportunity for the creation of a permanent national infrastructure that will collect data and products related to Space Weather. +Prospect +-------- + +Prospect... + + .. _CAESAR: https://caesar.iaps.inaf.it/ + + + + diff --git a/docs/source/conf.py b/docs/source/conf.py index c161dbfde9a29bd18b8849cd9ac1d604ea50b252..529c3ad8f7f36b4424267be0f8af8c3f02c48df3 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -2,11 +2,11 @@ # -- Project information -project = 'Caesar' +project = 'ASPIS' copyright = '2022, The Caesar/ASPIS team' author = 'CAESAR Node 2000' -release = '0.1' +release = '' version = '0.1.0' # -- General configuration diff --git a/docs/source/index.rst b/docs/source/index.rst index 54baaf8e6b4d7819c3ef49ffeeae25e7130d693e..2233b2972bd015343d2ec0bec77852330dce23e3 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,22 +1,15 @@ -Welcome to CAESAR documentation! +Welcome to ASPIS documentation! =================================== -This is the CAESAR Project live documentation. Here you can learn how to use CAESAR webapp, CAESAR aspis.py library and have a look about the informations of the data products hosted in CAESAR systems. +This is the **ASPIS** service live documentation. Here you can learn how to use **ASPIS** webapp, aspis.py library and have a look about the informations of the data products hosted in **ASPIS** systems. +.. image:: assets/images/logo_ASPIS_prtscrn.png + :height: 320 + :align: center + :alt: ASPIS logo -CAESAR in brief -======== - -**CAESAR** (Comprehensive Space Weather Studies for the ASPIS Prototype Realization) is a project supported by the Italian Space Agency and the National Institute of Astrophysics through the ASI-INAF n.2020-35-HH.0 agreement for the development of the ASPIS prototype of scientific data centre for Space Weather. - -.. image:: assets/images/CAESAR_logo_fullsize_color.png - :height: 220 - :alt: Alternative text - -Check out the :doc:`CAESAR` section for further information, including the details on :ref:`ASPIS` the project. - -To read about the latest news of the project please, visit the website `CAESAR project `_ - +An environment where scientists can discover, understand, and model the connection between solar phenomena, interplanetary +disturbances, cosmic rays, and their impacts on the planets (especially the Earth). Contents ======== @@ -24,11 +17,11 @@ Contents .. toctree:: :caption: Table of Contents :name: mastertoc - :maxdepth: 5 + :maxdepth: 2 :glob: - caesar aspis + caesar products/main diff --git a/docs/source/products/data_products.rst b/docs/source/products/data_products.rst index 030f98b0bdf10be5faea3298a7aca51f4b932614..74f252a0e7cca77efa03b65c50184a072287f90d 100644 --- a/docs/source/products/data_products.rst +++ b/docs/source/products/data_products.rst @@ -1,11 +1,8 @@ Data Products ------- - -Catalogue -^^^^^ +------------- .. toctree:: + :titlesonly: :glob: - :maxdepth: 2 - data/* \ No newline at end of file + data/* diff --git a/docs/source/products/main.rst b/docs/source/products/main.rst index 6aa8fc59359a07c16066daf00b49ac23dd27b6fd..eafa591c60d1a96f2d1742a1f8b1d38b331239f5 100644 --- a/docs/source/products/main.rst +++ b/docs/source/products/main.rst @@ -5,4 +5,4 @@ Product Catalogue .. include:: data_products.rst -.. include:: sw_products.rst \ No newline at end of file +.. include:: sw_products.rst diff --git a/docs/source/products/sw_products.rst b/docs/source/products/sw_products.rst index 513ad9ab55b3aecbc17e7f563149c9961d58f35c..15eb74bdd4e33e633d454d28b7dcb175f8b85ef2 100644 --- a/docs/source/products/sw_products.rst +++ b/docs/source/products/sw_products.rst @@ -1,11 +1,8 @@ Software Products ------- - -Catalogue -^^^^^^ +----------------- .. toctree:: + :titlesonly: :glob: - :maxdepth: 2 - software/* \ No newline at end of file + software/*