Atualiza a documentacao com novos recursos

frontend/user_docs/docs/faq.md

@@ -2,23 +2,25 @@
 
 ## What are the main data sources used in the predictions?
 
-All predictions are computed using the PRAIA software (cit.) and the search of events is limited to stars with magnitude up to 18. The limiting magnitude is imposed because it would be impossible for most observers to register events with high cadence on fainter stars without powerful telescopes and expensive cameras. We can, however, compute predictions at higher magnitudes for objects on demand. Below, we list the sources and versions of our inputs.
+All predictions are computed using the PRAIA package ([Assafin et al. 2010](https://ui.adsabs.harvard.edu/abs/2010gfss.conf...85A/abstract), [Assafin 2023a](https://ui.adsabs.harvard.edu/link_gateway/2023P&SS..23805801A/doi:10.1016/j.pss.2023.105801), [Assafin 2023b](https://ui.adsabs.harvard.edu/link_gateway/2023P&SS..23905816A/doi:10.1016/j.pss.2023.105816)) and the search of events is limited to stars with magnitude up to 18. The limiting magnitude is imposed because it would be impossible for most observers to register events with high cadence on fainter stars without powerful telescopes and expensive cameras. We can, however, compute predictions at higher magnitudes for objects on demand. Below, we list the sources and versions of our inputs.
 
 | Element             | Source   | Version         |
 | ------------------- | -------- | --------------- |
 | Object ephemeris    | JPL/Nasa | Latest availabe |
 | Planetary ephemeris | JPL/Nasa | de440           |
 | Leap Second Kernel  | JPL/Nasa | NAIF0012        |
-| Star Catalog        | Gaia     | DR2             |
+| Star Catalog        | Gaia     | DR3             |
 | Step Size           | 60 s     | --              |
 
 ## Why can't I find occultations for a specific object?
 
+It is possible to search for the occultations by an object using its designation or provisional designation. In the latest, note that you should include a space between the year and the letters for its designation, for example, search for "2003 VS2" not "2003VS2". Note that the search field is **not** case sensitive.
+
 If you type in the name of an object and it does not show up in the drop-down list, there are no occultation predictions for that object at that time.
 
 ## Will a prediction always result in an observed occultation?
 
-No. It is important to note that predictions are made based on the available orbit information at the time of computation. Some orbits may be poorly constrained, which can result in predictions that may not come to fruition. To address this challenge, we plan to introduce metrics in the future that will provide insights into the accuracy of a given prediction. Our aim is to provide users with the most reliable and informative predictions possible, while also acknowledging the limitations of the available data.
+No. It is important to note that predictions are made based on the available orbit information at the time of computation. Some orbits may be poorly constrained, which can result in predictions that may not come to fruition. Note in the Occultation Prediction Map that there are red dashed lines showing the occultation uncertainty, providing insights into the accuracy of a given prediction. Our aim is to provide users with the most reliable and informative predictions possible, while also acknowledging the limitations of the available data.
 
 ## Can I select multiple asteroids to apply the filter?
 

frontend/user_docs/docs/index.md

@@ -14,8 +14,8 @@ This database was developed to universalize access in an easy and interactive wa
 
 ## A quick note on Stellar Occultations
 
-Stellar occultations happen when a moving object, such as an asteroid, passes in front of a star, blocking its light from view for a short time. These events can also be thought of from a different perspective, such as the object's cast shadow (with the source of light being the star) moving across the Earth's surface. People within the shadow's path with a telescope and the right conditions can register the occultation event.
+Stellar occultations occur when a moving object, such as an asteroid, passes in front of a star in the observer’s line of sight, temporarily blocking its light from view. These events can also be thought of from a different perspective, such as the object's cast shadow (with the source of light being the star) moving across the Earth's surface. People within the shadow's path with a telescope and the right conditions can register the occultation event.
 
-From our point of view, stars are constantly obscured by bodies of the Solar System since they form, in simple terms, the background plane of the sky we observe every night. Therefore, these events are a goldmine for studying many aspects of our Solar System—especially the size, shape, and surroundings of small bodies. This is possible due to one of the most outstanding features of the occultation technique: the translation of high temporal resolution into high angular resolution. In other words, the higher the cadence we image an event, the more refined information we can get on the object's characteristics and neighborhood, such as elevations, depressions, rings, etc.
+From an observer's point of view, stars are constantly obscured by bodies of the Solar System since they form, in simple terms, the background plane of the sky we observe every night. Therefore, these events are a goldmine for studying many aspects of our Solar System — especially the size, shape, and surroundings of small bodies. This is possible due to one of the most outstanding features of the occultation technique: the translation of high temporal resolution into high angular resolution. In other words, the higher the cadence we image an event, the more refined information we can get on the object's characteristics and neighborhood, such as elevations, depressions, rings, etc.
 
-Now that we have more clarity on what these events are and how useful they can be, it becomes clearer why it is relevant to make accurate predictions, and doing that requires constantly updated knowledge of how the objects move over time as well as detailed star charts. This information is crucial to determine precisely where and when these events occur. By using observations of the objects' paths and combining them with star data, astronomers can identify when and where these stellar occultations are expected to occur. But here, we aim to go a step further and also let you know what events will happen around where you live or any other region of interest.
+Now that we have a better understanding of these events and their usefulness, it becomes clearer why it is relevant to make accurate predictions, and doing that requires constantly updated knowledge of how the objects move over time as well as detailed star charts. This information is crucial to determine precisely *where* and *when* these events occur. By using observations of the objects' paths and combining them with star data, astronomers can identify when and where these stellar occultations are expected to occur. But here, we aim to go a step further and also let you know what events will happen around where you live or any other region of interest.

frontend/user_docs/docs/release-notes/01-2024-initial-release.md

@@ -4,7 +4,7 @@
 
 Release date: April 2nd, 2024.
 
-**Please be advised this is our initial _beta release_**. Not all asteroid classes are included. At this stage occultation predictions are computed only for the outer Solar System objects including **Trojans**, **Centaurs**, **Kuiper Belt**, and **Inner Oort Cloud** objects.
+**Please be advised this is our initial _beta release_**. Not all asteroid classes are included. At this stage occultation predictions are computed only for the outer Solar System objects including those classified as **Trojans**, **Centaurs**, **Kuiper Belt**, and **Inner Oort Cloud**.
 
 The total number of predictions also include a small percentage of events that happen strictly during the day, which are in very special cases of interest to some astronomers.
 

frontend/user_docs/docs/release-notes/02-2024-gaia-dr3-release.md

@@ -6,7 +6,7 @@ Release date: April 21st, 2024.
 
 Main updates include the use of Gaia DR3 star catalogue and new filter options such as magnitude drop, event duration, and object size.
 
-At this stage occultation predictions are computed only for the outer Solar System objects including **Trojans**, **Centaurs**, and **Kuiper Belt** objects.
+At this stage occultation predictions are computed only for the outer Solar System objects including those classified as **Trojans**, **Centaurs**, and **Kuiper Belt**.
 
 The total number of predictions also include a small percentage of events that happen strictly during the day, which are in very special cases of interest to some astronomers.
 

frontend/user_docs/docs/release-notes/latest-release.md

@@ -4,7 +4,7 @@
 
 Release date: September 5th, 2024.
 
-Main updates include the computation of uncertainties at the closest approach and closest apporach instant and includes the newly developed python module lineaSSP to retrive predictions programatically. It also offers a new filtering option by the shaddow path uncertainty in kilometers.
+Main updates include the computation of uncertainties related to the the closest approach, and includes the newly developed python module lineaSSP to retrive predictions programatically. It also offers a new filtering option by the shaddow path uncertainty in kilometers.
 
 At this stage occultation predictions are computed only for the outer Solar System objects including **Trojans**, **Centaurs**, and **Kuiper Belt** objects.
 

frontend/user_docs/docs/user-guide/api.md

@@ -4,8 +4,8 @@
 
 The LIneA Occultation Prediction Database (LOPD) API is a solution for querying and managing predictions of stellar occultations programatically. With this API, you can:
 
-- Search for occultation prediction events by various parameters such as date, time, magnitude.
-- Customize and filter occultation prediction events based on date/time intervals, magnitude limits, object names, dynamical classes, and subclasses.
+- Search for occultation prediction events by various parameters such as date, time, star magnitude.
+- Customize and filter occultation prediction events based on date/time intervals, star magnitude limits, object names, dynamical classes, and subclasses.
 - Access geolocation filtering (experimental) for refined results, among other things.
 - Query asteroids properties, and more.
 
@@ -61,7 +61,7 @@ The API key is personal and non-transferable, and should not be shared with thir
 
 The LOPD API handles the following features:
 
-- **Occultation**: It is an event that contains information regarding the occulting object, such as date and time, apparent magnitude, geocentric distance, etc. Additionally, it provides information about the candidate star to be occulted, such as right ascension, declination, apparent magnitude, etc. Moreover, it includes predictive information about the event, such as the expected drop in magnitude during the occultation, among other data.
+- **Occultation**: It is an event that contains information regarding the occulting object, such as date and time, star apparent magnitude, object geocentric distance, etc. Additionally, it provides information about the candidate star to be occulted, such as right ascension, declination, apparent magnitude, etc. Moreover, it includes predictive information about the event, such as the expected drop in magnitude during the occultation, among other data.
 - **Asteroid**: Aggregates the set of information about a small body in the Solar System, including its orbital properties and, when available, some physical properties.
 - **Base Dynclass**: Contains the main dynamic classifications of asteroids as defined by [Skybot](https://ssp.imcce.fr/webservices/skybot/).
 - **Dynclass**: Contains the set of dynamic subclassifications of asteroids as defined by [Skybot](https://ssp.imcce.fr/webservices/skybot/).

frontend/user_docs/docs/user-guide/citations.md

@@ -1,3 +1,12 @@
 # Citations
 
-In preparation.
+The Linea Solar System Portal (`LineaSSP`) works due to an enourmous effort of many people. When using, please give the credits by citing the following works:
+
+- When using `lineaSSP`, for the moment please cite the portal and its [URL](https://solarsystem.linea.org.br). The official paper is in preparation and this documentation will be updated to the correc citation.
+
+- Predictions are made using the PRAIA package, pleasse cite [Assafin 2023](https://ui.adsabs.harvard.edu/abs/2023P%26SS..23805801A/abstract).
+
+- When using maps generated by `lineaSSP`, please cite the [SORA package](https://sora.readthedocs.io). To customize maps further, please refer to the detailed documentation available at [SORA maps generation documentation](https://sora.readthedocs.io/latest/examples/prediction/maps.html).
+
+
+

frontend/user_docs/docs/user-guide/filter-events.md

@@ -1,41 +1,64 @@
 # Filtering events
 
-The web dashboard offers intuitive customization for exploring occultation events, enabling users to easily adjust settings like date and time, visibility limits, geolocation, among other filters. This approach makes advanced filtering of occultation accessible to everyone.
+The web dashboard offers intuitive customization for exploring occultation predictions, enabling users to easily adjust settings such as date and time, star magnitude limits, geolocation, among other filters. This approach makes advanced filtering of occultation accessible to everyone.
 
 ### Date and Time Interval
 
-Allows you to select a specific time and date interval. **Be aware that the selection is based on your local time (timezone of the device) while the closest approach of occultations is given in UTC.**
+Allows you to select a specific time and date interval.
+
+User may input the **Start date and time** and **End date and time** (format MM/DD/YYYY HH:MM AM/PM), or select the dates in the pop icon at the right of the respective search fields.
+
+**Be aware that the date selection is based on your LOCAL TIME (timezone of the device) while the closest approach of occultations is given in UTC.**
 
 ### Magnitude Limit
 
-Provides an upper magnitude limit.
+Provides an upper magnitude limit for the occulted star.
+
+Star magnitudes range from 4 to 18.
 
 ### Filter Type
 
-There are three ways of filtering objects: by name/principal designation, dynamical class, and dynamical subclass:
+There are four ways of filtering objects: ''empty'', by name/principal designation, dynamical class, and dynamical subclass:
 
-- **Object name**: enter the name of the object and select it from the drop-down list. You can select multiple objects. If the name of the object does not appear on the drop-down list, it means that there are no occultations available for that object at the time.
-- **Dynamical class**: selects the group of objects that belong to a specific dynamical class. Asteroid dynamical classes (and subclasses) are used as defined by Skybot ([more information](https://ssp.imcce.fr/webservices/skybot/)).
+- **Empty**: no filter is applied. All objects (as specified in the latest release) will be listed.
+- **Object name**: type or search for the name of the object from the drop-down list, then select it. You can search and select for multiple objects. If the name of the object does not appear on the drop-down list, it means that there are no occultations available for that object at the time.
+- **Dynamical class**: selects the group of objects that belong to a specific dynamical class.
 - **Dynamical subclass**: selects the group of objects that belong to a specific subclass.
 
+  Note that Asteroid dynamical classes (and subclasses) are used as defined by Skybot ([more information](https://ssp.imcce.fr/webservices/skybot/)).
+
 ### Local Solar Time
 
 On by default. When activated, it takes a step further in constraining the closest approach instant to a specific local time (in terms of longitude). Selecting a time range from 6 PM to 6 AM will filter out all events whose closest approach instant is not within this range. This helps, for example, to filter out events occurring during dawn, dusk, or less interesting events whose closest approach occurs at daylight. It strictly considers solar time, not to be confused with the local time taking into account timezones.
 
 ### Hide Diurn Events
 
-On by default, it filters out occultations whose paths happen exclusively during daytime and paths that do not cross the Earth at all.
+On by default, it filters out occultations whose full paths (with uncertainties) happen exclusively during daytime and paths that do not cross the Earth at all.
 
 ### Duration and Size
 
-Provide options to filter events by the expected magnitude drop (lower limit), the event duration (lower limit, only when the object's diameter is defined) and size of the asteroid (interval, only when the object's diameter is defined).
+Provide options to filter events by four parameters:
+- **Magnitude drop**: the expected magnitude drop (lower limit).
+- **Event duration**: the total event duration (lower limit, filters only when the object's diameter is defined).
+- **Uncertainty**: the closest approach uncertainty in km.
+- **Diameter**: minimum and maximum object size (filters only when the object's diameter is defined).
 
 ### Geolocation Filter
 
 _The geolocation filter is experimental and is intended to be the last filter option to be applied._ Since it is computationally costly, we recomend to filter down your results using the previous filtering options to an amount of **at most 2000 events** as indicated in the image below. It can be acomplished for instance using a narrower datetime interval or set of objects.
 
-Latitude and longitude must be presented in degrees. Negative latitudes indicate the South, while positive ones indicate the North. Negative longitudes correspond to the West, while positive ones correspond to the East. The radius represents the distance in kilometers around the provided latitude and longitude.
+Off by default. When activated, it takes a step further in constraining the closest approach instant to a specific location, in terms of latitude, longitude, locarion radius, and uncertainties.
+
+Latitude and longitude must be presented in degrees. Negative latitudes correspon to the South, while positive ones are to the North. Negative longitudes correspond to the West, while positive ones are the East.
+
+The Location radius represents the distance in kilometers around the provided latitude and longitude for the occultation path.
 
 > **Atention** ><br/>Be aware that activating this filter without following the instructions will result either in incomplete results or in timeout by the server.
 
 ![Image Alt Text](../static/geolocation_filter.png)
+
+### CLEAR and HELP buttons
+
+The **CLEAR** button will clear all the input filters, reseting to the default values.
+
+The **HELP** button will forward to this documentation URL.