catalog.browse module

Functions that open a ScienceBase resource in a web browser.

Function

catalog

Opens the ScienceBase catalog in a web browser

extents

Opens extent type info in a web browser

item

Opens a ScienceBase catalog item in a web browser

parent

Opens the PWFDF parent item in a web browser

search

Opens a ScienceBase catalog search in a web browser

status

Opens the ScienceBase catalog status page in a web browser
pwfdf_api.catalog.browse.catalog(*, new=0, autoraise=True)

Opens the ScienceBase catalog in a web browser

Open Catalog
catalog()

Opens the main ScienceBase catalog page in a web browser.

Browser Options
catalog(..., *, new)
catalog(..., *, autoraise=False)

Web browser options. The “new” input controls how the page is opened. 0 opens in the current window, 1 opens a new window, and 2 opens a new tab. Set autoraise=False to disable raising the opened page when possible. Note that many web browsers ignore both these options.

Inputs:

new: (0 - default) current window, (1) new window, (2) new tab autoraise: True (default) to autoraise the page. False to not autoraise

Outputs:

bool: True if the page was opened successfully. Otherwise False.

pwfdf_api.catalog.browse.extents(*, new=0, autoraise=True)

Opens the ScienceBase extent info page in a web browser

Open Extent Info
extents()

Opens the ScienceBase extent info page in a web browser.

Browser Options
extents(..., *, new)
extents(..., *, autoraise=False)

Web browser options. The new input controls how the page is opened. 0 opens in the current window, 1 opens a new window, and 2 opens a new tab. Set autoraise=False to disable raising the opened page when possible. Note that many web browsers ignore both these options.

Inputs:

  • new (0 | 1 | 2) – (0 - default) current window, (1) new window, (2) new tab

  • autoraise (bool) – True (default) to autoraise the page. False to not autoraise

Outputs:

bool – True if the page was opened successfully. Otherwise False.

pwfdf_api.catalog.browse.item(id, *, new=0, autoraise=True)

Opens a ScienceBase item page in a web browser

Open Item
item(id)

Opens a ScienceBase item page in a web browser.

Browser Options
item(..., *, new)
item(..., *, autoraise=False)

Web browser options. The new input controls how the page is opened. 0 opens in the current window, 1 opens a new window, and 2 opens a new tab. Set autoraise=False to disable raising the opened page when possible. Note that many web browsers ignore both these options.

Inputs:

  • id (str) – The ID of the ScienceBase catalog item

  • new (0 | 1 | 2) – (0 - default) current window, (1) new window, (2) new tab

  • autoraise (bool) – True (default) to autoraise the page. False to not autoraise

Outputs:

bool – True if the page was opened successfully. Otherwise False.

pwfdf_api.catalog.browse.parent(*, new=0, autoraise=True)

Opens the PWFDF parent item in a web browser

Open PWFDF Parent
parent()

Opens the PWFDF parent item in a web browser.

Browser Options
parent(..., *, new)
parent(..., *, autoraise=False)

Web browser options. The new input controls how the page is opened. 0 opens in the current window, 1 opens a new window, and 2 opens a new tab. Set autoraise=False to disable raising the opened page when possible. Note that many web browsers ignore both these options.

Inputs:

  • new (0 | 1 | 2) – (0 - default) current window, (1) new window, (2) new tab

  • autoraise (bool) – True (default) to autoraise the page. False to not autoraise

Outputs:

bool – True if the page was opened successfully. Otherwise False.

pwfdf_api.catalog.browse.status(*, new=0, autoraise=True)

Opens the ScienceBase catalog status page in a web browser

Open Catalog Status
status()

Opens the ScienceBase catalog status page in a web browser.

Browser Options
status(..., *, new)
status(..., *, autoraise=False)

Web browser options. The new input controls how the page is opened. 0 opens in the current window, 1 opens a new window, and 2 opens a new tab. Set autoraise=False to disable raising the opened page when possible. Note that many web browsers ignore both these options.

Inputs:

  • new (0 | 1 | 2) – (0 - default) current window, (1) new window, (2) new tab

  • autoraise (bool) – True (default) to autoraise the page. False to not autoraise

Outputs:

bool – True if the page was opened successfully. Otherwise False.