Skip to content

Commit

Permalink
Merge pull request #5 from asfadmin/test
Browse files Browse the repository at this point in the history
Test to Production with phrase-translate-to-md.py execution
  • Loading branch information
artisticlight authored Oct 30, 2023
2 parents f7973f0 + 4d5e9c6 commit 957a1f4
Show file tree
Hide file tree
Showing 48 changed files with 4,669 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .github/workflows/deploy_to_github_io.yml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ jobs:
run: |
python -m pip install --upgrade pip
python -m pip install -r Discovery-MkDocs/requirements.txt
python phrase-translate-to-md.py Discovery-MkDocs
- name: deploy to github.io
if: github.ref == 'refs/heads/prod'
Expand Down
25 changes: 25 additions & 0 deletions markdown-docs/api/basics.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Search API Basics

Building a Search API query consists of 3 basic steps:

1. Use the Search API base URL: https://api.daac.asf.alaska.edu
2. Pick an endpoint. All available endpoints are listed in the [Keywords documentation](/api/keywords). The Search endpoint uses this base URL: https://api.daac.asf.alaska.edu/services/search/param
3. Build your query using [keywords](/api/keywords)

The completed URL will be in this format: https://api.daac.asf.alaska.edu/services/search/param?keyword1=value1&keyword2=value2,value3&keyword3=value4-6

Once your query is built, you may execute by copy/pasting into a browser window, a command line interface, or by using a program. More details on various options and some syntax tips can be found in the [Search API Tools documentation](/api/tools).

**Downloading Data**

In order to download data, you will need a NASA EOSDIS Earthdata Login account. Earthdata accounts are free. Go to [Earthdata Login — Create Profile](https://urs.earthdata.nasa.gov/users/new) to create an account.

You will be prompted to accept the ASF End-User License Agreement and set a Study Area to complete your new user setup.

*Note: A research agreement is required for access to JERS-1 and RADARSAT-1 data. Please complete the required [Research Agreement](https://asf.alaska.edu/restricted-data-access-request), or contact user support at the email or number below.*

**Next Steps**

See [Search API Keywords](/api/keywords) to get started on building a query, or see the [Tools page](/api/tools) for some examples.

Alternatively, you may wish to use asf_search, a Python module for performing searches of the ASF catalog. It also offers baseline functionality and download support. Additionally, numerous constants are provided to ease the search process. It is available through PyPi and Conda. More information can be found [here](/asf_search/basics).
28 changes: 28 additions & 0 deletions markdown-docs/api/basics.es.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Conceptos básicos de la API de búsqueda

La creación de una consulta de la API de búsqueda consta de 3 pasos básicos:

1. Utilice la URL base de la API de búsqueda: https://api.daac.asf.alaska.edu
2. Elija un punto final. Todos los puntos finales disponibles se enumeran en la [Documentación de palabras clave](/api/keywords). El extremo de búsqueda usa esta dirección URL base: https://api.daac.asf.alaska.edu/services/search/param
3. Cree su consulta usando [palabras clave](/api/palabras clave)

La URL completada estará en este formato: https://api.daac.asf.alaska.edu/services/search/param?keyword1=value1&keyword2=value2,value3&keyword3=value4-6

Una vez que se genera la consulta, puede ejecutarla copiando/pegando en una ventana del explorador, una interfaz de línea de comandos o mediante un programa. Puede encontrar más detalles sobre varias opciones y algunas sugerencias de sintaxis en la [documentación de Search API Tools](/api/tools).




**Descarga de datos**

Para descargar datos, necesitará una cuenta de inicio de sesión de NASA EOSDIS Earthdata. Las cuentas de Earthdata son gratuitas. Vaya a [Earthdata Login — Create Profile](https://urs.earthdata.nasa.gov/users/new) para crear una cuenta.

Se le pedirá que acepte el Acuerdo de licencia de usuario final de ASF y establezca un Área de estudio para completar su nueva configuración de usuario.

*Nota: Se requiere un acuerdo de investigación para acceder a los datos de JERS-1 y RADARSAT-1. Complete el [Acuerdo de investigación] requerido (https://asf.alaska.edu/restricted-data-access-request) o comuníquese con el servicio de atención al usuario en el correo electrónico o número a continuación.*

**Próximos pasos**

Consulte [Buscar palabras clave de API](/api/keywords) para empezar a crear una consulta, o consulte la [Página de herramientas](/api/tools) para ver algunos ejemplos.

Alternativamente, es posible que desee utilizar asf_search, un módulo de Python para realizar búsquedas en el catálogo de ASF. También ofrece funcionalidad básica y soporte de descarga. Además, se proporcionan numerosas constantes para facilitar el proceso de búsqueda. Está disponible a través de PyPi y Conda. Puede encontrar más información [aquí](/asf_search/basics).
33 changes: 33 additions & 0 deletions markdown-docs/api/changelog.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# What's New

## New Python module for performing searches
asf_search is a Python module for performing searches of the ASF catalog. In addition, it offers baseline functionality and download support. It is available through PyPi and Conda. More information can be found [here](/asf_search/basics).

## Multiple Endpoints Available

In addition to the Search endpoint, we have multiple endpoints available for all of your Search API needs. Below is a brief overview of what's available. More details on these endpoints and how to use them can be found on the [Keywords page](/api/keywords).


**Baseline Endpoint**

This endpoint can be used to search for baseline data using specific reference scenes.

**WKT Endpoints**

The WKT validation endpoint will validate and repair a WKT input. The GeoSpatial Files to WKT endpoint will accept a POST request with files attached. It will return the parsed WKT from the file, as well as the repaired wrapped and unwrapped WKT.

**Date Parser Endpoint**

This endpoint can be used to check how dates are parsed by the Search API.

**Mission List Endpoint**

This endpoint lists all missions (also known as campaigns or collections) for all datasets.

**Health Endpoint**

This endpoint is used to check the Search API health. It also provides information on CMR health.

## Preferred Search API Output Format

GeoJSON is the preferred Search API output format. You can specify the output format with keyword "output". If you find a required field that is not included in GeoJSON output, please contact ASF using the info below or reach the team directly at <[email protected]>.
32 changes: 32 additions & 0 deletions markdown-docs/api/changelog.es.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Novedades

## Nuevo módulo de Python para realizar búsquedas
`asf_search` es un módulo de Python para realizar búsquedas en el catálogo de ASF. Además, ofrece funcionalidad básica y soporte de descarga. Está disponible a través de PyPi y Conda. Puedes encontrar más información [aquí](/asf_search/basics).

## Múltiples puntos finales disponibles

Además del punto final de búsqueda, tenemos varios puntos finales disponibles para todas tus necesidades de API de búsqueda. A continuación, se presenta una breve descripción de lo que está disponible. Puedes encontrar más detalles sobre estos puntos finales y cómo utilizarlos en la [página de Palabras clave](/api/keywords).

**Punto final de línea base**

Este punto final se puede utilizar para buscar datos de referencia específicos.

**Puntos finales WKT**

El punto final de validación WKT validará y reparará una entrada WKT. El punto final de archivos geoespaciales a WKT aceptará una solicitud POST con archivos adjuntos. Devolverá el WKT analizado del archivo, así como el WKT reparado con y sin envolver.

**Punto final del analizador de fechas**

Este punto final se puede utilizar para verificar cómo se analizan las fechas mediante la API de búsqueda.

**Punto final de lista de misiones**

Este punto final enumera todas las misiones (también conocidas como campañas o colecciones) de todos los conjuntos de datos.

**Punto final de estado de salud**

Este punto final se utiliza para verificar el estado de salud de la API de búsqueda. También proporciona información sobre el estado de salud de CMR.

## Formato de salida preferido de la API de búsqueda

El formato GeoJSON es el formato de salida preferido de la API de búsqueda. Puedes especificar el formato de salida con la palabra clave "output". Si encuentras un campo requerido que no está incluido en la salida GeoJSON, por favor, contacta a ASF utilizando la información a continuación o comunícate directamente con el equipo en <[email protected]>.
23 changes: 23 additions & 0 deletions markdown-docs/api/cookbook.en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Search API Tips & Tricks

This is a collection of some tips & tricks for the Search API!

## New Python module for performing searches
asf_search is a Python module for performing searches of the ASF catalog. In addition, it offers baseline functionality and download support. It is available through PyPi and Conda. More information can be found [here](/asf_search/basics).

## Rate Limitation on Search Endpoint
There has been a rate limitation instituted on the [search endpoint](/api/keywords/#search-endpoint). The rate limitation is per IP and is currently 250 queries per minute. Upon hitting the limit, further queries will yield a HTTP 429 with an error message. Check to see if your queries are returning a small number of results. If so, you can refine your parameters to combine result sets into larger groups and then post-process those results locally. For instance, instead of searching on a small area of interest with an individual query for each day, select a larger date range in order to create a single query, then split the results apart after they have been retrieved.

## Vertex Copy/Paste Search API URL
Have you have completed a geo search in Vertex, that you'd like to replicate in a Search API query? Click the Down Arrow under the Max Results. Choose "API URL...".

Here you can see the Search API URL you would use to replicate the search. You may change the maxResults and output format. Once you are satisfied, click the copy icon. Now you can paste the query into a browser or command line interface to execute it.

## Find the Product_List Value in Vertex
The product/file name is listed in Vertex Search Results, under the Files detail column. You can click the Copy icon to copy the File ID. You can also copy all File IDs from your Download Queue in Vertex. Once you have your desired list of files, you can find them via the Search API using the product_list keyword.

## Search Results Can Become Search Area
You can turn your search results into a search area. First, export your search results as GeoJSON or KML output format. Next, import your file into Vertex geo search. Vertex will extract the AOI from your file. If desired, you can add filters and can save your search filters or the search itself.

## Verify Your Query is Returning the Correct Number of Results
Would you like to verify that your query has returned the correct number of results? Change your output to "output=count" to verify. If the count does not match, consider narrowing your search by using more keywords, or by using keyword “maxResults” to limit it. You may also try shortening the date range to split your search into a series of smaller searches.
23 changes: 23 additions & 0 deletions markdown-docs/api/cookbook.es.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Consejos y Trucos para la API de Búsqueda

¡Esta es una colección de algunos consejos y trucos para la API de Búsqueda!

## Nuevo módulo de Python para realizar búsquedas
`asf_search` es un módulo de Python para realizar búsquedas en el catálogo de ASF. Además, ofrece funcionalidad básica y soporte de descarga. Está disponible a través de PyPi y Conda. Puedes encontrar más información [aquí](/asf_search/basics).

## Limitación de velocidad en el punto final de búsqueda
Se ha implementado una limitación de velocidad en el [punto final de búsqueda](/api/keywords/#search-endpoint). La limitación de velocidad es por dirección IP y actualmente es de 250 consultas por minuto. Al alcanzar el límite, las consultas adicionales devolverán un HTTP 429 con un mensaje de error. Verifica si tus consultas están devolviendo un pequeño número de resultados. Si es así, puedes refinar tus parámetros para combinar conjuntos de resultados en grupos más grandes y luego procesar esos resultados localmente. Por ejemplo, en lugar de buscar en una pequeña área de interés con una consulta individual para cada día, selecciona un rango de fechas más amplio para crear una sola consulta, luego divide los resultados después de haberlos recuperado.

## Copiar/Pegar URL de la API de Búsqueda desde Vertex
¿Has completado una búsqueda geoespacial en Vertex que te gustaría replicar en una consulta de la API de Búsqueda? Haz clic en la flecha hacia abajo debajo de "Max Results". Elige "API URL...".

Aquí puedes ver la URL de la API de Búsqueda que utilizarías para replicar la búsqueda. Puedes cambiar el número máximo de resultados y el formato de salida. Una vez que estés satisfecho, haz clic en el icono de copia. Ahora puedes pegar la consulta en un navegador o interfaz de línea de comandos para ejecutarla.

## Encontrar el Valor de Product_List en Vertex
El nombre del producto/archivo se encuentra en los Resultados de Búsqueda de Vertex, en la columna de detalles de los archivos. Puedes hacer clic en el icono de copia para copiar el ID del archivo. También puedes copiar todos los ID de archivos desde tu cola de descargas en Vertex. Una vez que tengas la lista deseada de archivos, puedes encontrarlos a través de la API de Búsqueda utilizando la palabra clave "product_list".

## Los Resultados de Búsqueda Pueden Convertirse en un Área de Búsqueda
Puedes convertir tus resultados de búsqueda en un área de búsqueda. Primero, exporta tus resultados de búsqueda en formato de salida GeoJSON o KML. Luego, importa tu archivo en la búsqueda geoespacial de Vertex. Vertex extraerá el Área de Interés (AOI) de tu archivo. Si lo deseas, puedes agregar filtros y guardar tus filtros de búsqueda o la búsqueda misma.

## Verificar que tu Consulta Devuelva el Número Correcto de Resultados
¿Te gustaría verificar que tu consulta haya devuelto el número correcto de resultados? Cambia tu salida a "output=count" para verificarlo. Si el recuento no coincide, considera acotar tu búsqueda utilizando más palabras clave o utilizando la palabra clave "maxResults" para limitarla. También puedes intentar acortar el rango de fechas para dividir tu búsqueda en una serie de búsquedas más pequeñas.
Loading

0 comments on commit 957a1f4

Please sign in to comment.