Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ocelot development plan #1

Open
3 of 16 tasks
emilyhunt opened this issue Dec 15, 2023 · 0 comments
Open
3 of 16 tasks

ocelot development plan #1

emilyhunt opened this issue Dec 15, 2023 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@emilyhunt
Copy link
Owner

emilyhunt commented Dec 15, 2023

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
@emilyhunt emilyhunt added documentation Improvements or additions to documentation enhancement New feature or request labels Dec 15, 2023
@emilyhunt emilyhunt self-assigned this Dec 15, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant