Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

957 Atualiza documentação com updates do frontende #960

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 20 additions & 11 deletions frontend/user_docs/docs/release-notes.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,22 @@
# Initial Release

| | |
| ---------------------------------------------- | --------------------------------------------------------- |
| Number of asteroids with prediction events | 15609 |
| Number of prediction events | 668920 |
| Earliest prediction in this release | Jan, 1st 2024 |
| Latest prediction in this release | Jan, 1st 2025 |
| Dynamical classes of asteroids in this release | Centaur, Trojan, Kuiper Belt Object, and Inner Oort Cloud |
| Source of asteroids ephemrides | JPL/NASA |
| Source of planetary ephemeris | de440 - JPL/NASA |
| Leap second kernel | NAIF0012 - JPL/NASA |
| Source of star catalog | Gaia DR2 / ESA |
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.

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.

Below are the description of the main input sources and the outputs produced in this release.

| Description | Value |
| ------------------------------------------ | ----------------------------------------------------------------- |
| Date of the release | 02/04/2024 |
| Number of asteroids with prediction events | 18,460 |
| Number of prediction events | 782,353 |
| Earliest prediction in this release | Jan, 1st 2024 |
| Latest prediction in this release | Jan, 1st 2025 |
| Asteroid dynamical classes included | Centaur <br/>Trojan <br/>Kuiper Belt Object <br/>Inner Oort Cloud |
| Source of asteroids ephemerides | JPL/NASA |
| Source of planetary ephemerides | de440 - JPL/NASA |
| Leap second kernel | NAIF0012 - JPL/NASA |
| Source of star catalog | Gaia DR2 / ESA |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 14 additions & 8 deletions frontend/user_docs/docs/user-guide/filter-events.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,36 @@

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.

### Date and time interval
### 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.**

### Magnitude limit
### Magnitude Limit

Provides an upper magnitude limit.

### Filter type
### Filter Type

There are three ways of filtering objects: 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/)).
- **Dynamical subclass**: selects the group of objects that belong to a specific subclass.

### Nightime only
### 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.

### Local time filter
### 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.

It is a step further to constraint the closest approach instant to a certain local time. Selecting a time range from 06 PM to 06 AM will filter out all events whose C/A instant is locally within this range. It helps, for example, filter out events that happen during dawn or dusk.
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.

### Geolocation filter
> **Atention** ><br/>Be aware that activating this filter without following the instructions will result either in incomplete results or in timeout by the server.

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 500 events. It can be acomplished for instance using a narrower datetime interval or set of objects. Be aware that activating this filter with a big number of events will result in timeout by server, sometimes without warning.
![Image Alt Text](../static/geolocation_filter.png)
Loading