Skip to content

ocelot development plan #1

Description

@emilyhunt

There are a lot of things I want to do with ocelot, and a lot of bits of legacy code that need improving. This is a list of big changes that should be made to the code.

0.4.0 - breaking changes:

  • Stop importing everything
  • Remove functions that aren't likely to be useful
  • Refactor function locations & package structure
  • Change function naming to be more consistent
  • Simplify configuration settings for functions (cut down on number of kwargs in some cases)
  • Switch to a more functional approach in some cases
  • Migrate to numpy docstring format
  • Setup API reference docs
  • Add basic test data packaged with library
  • Update tests
  • Get published on pypi

0.5.0 - improve usability:

  • Add support for astropy tables
  • Add global configuration settings + config file
  • Add some 'low hanging fruit' code from private repos I have (like max likelihood distances. Stuff that's useful)
  • Set up a Jupyter notebook -> docs link
  • Write some basic tutorials

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions