Skip to content

lkdata requires a user friendly notebook to show how to use the package in a general sense #10

Description

@christinahedges

lkdata will be a base package that we will be using for other parts of our ecosystem. While we don't expect many users for this package directly, we ourselves are users! We need a notebook for this package that will be part of the docs. This notebook needs to cover

  • Short explanation of what lkdata is
  • Example with random data for DataSeries, DataFrame, DataCube
  • Example for DataSeries, DataFrame, DataCube with errors
  • Example with DataSet
  • Examples of manipulating (slice, indexing, downsampling, etc)
  • Example with boolean cubes and other unusual cubes
  • Example showing using astronomy data (e.g. TESS data)
  • Examples with astronomy data showing how to manipulate (e.g. apertures, slicing, indexing)

This can be one notebook or a set of notebook. The notebook should be delivered as part of the docs folder and should update the sphinx configuration to have it load in a reasonable place.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

Fields

No fields configured for Task.

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions