Getting started#

Install ska#

ska is available on the python package index as space-ska:

$ pip install space-ska

The minimum version requirement for python is 3.11. After installation, you have the ska executable available system-wide. In addition, you can now import the ska python package.

$ ska

Usage: ska [OPTIONS] COMMAND [ARGS]...

  CLI for Spectral-Kit for Asteroids.

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  color       Compute the color between two filters
  docs        Open the ska documentation in browser.
  filter      Display the basic properties of the filter
  id          Fuzzy-search SVO filter index.
  plot-filter    Display a simple figure of the transmission of the filter
  plot-spectrum  Display a simple figure of the spectrum
  solarcolor  Compute the color of the Sun between two filters
  status      Echo the status of the cached filters.
>>> import ska

ska is still in its early days, and new versions come out frequently.

Manage ska cache#

ska relies extensively on the SVO Filter Profile Service for all the aspects related to filters (both the list and their properties). ska also needs a reference spectrum of Vega (for Vega photometric system, see How does it work), and of the Sun (for solar colors), as well as templates for asteroids taxonomic classes.

To speed up ska those files are cached locally. It is recommended to update the cache regularly, by running the following command:

$ ska status

Contents of /home/bcarry/.cache/ska:

        10 filters
        2 spectra
        1 spectral template files

Update or clear the cached filters and filter list?
[0] No [1] Clear cache [2] Update data  (0):