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

Misc changes / cleanup before v0.1 #70

Merged
merged 10 commits into from
Jul 14, 2017
Merged

Misc changes / cleanup before v0.1 #70

merged 10 commits into from
Jul 14, 2017

Conversation

cdeil
Copy link
Contributor

@cdeil cdeil commented Jul 14, 2017

This pull request contains some misc changes and cleanup I'd like to make before releasing v0.1:

  • Don't expose hips.utils in the public docs. Make it simple for end-users and expose everything they should know about in the top-level hips namespace. The one thing from hips.utils that they need is WCSGeometry, which I import into the top-level hips namespace.
  • Shorten the docs landing page, move the content to a new "about" page.
  • Update drawing description to what we do in the code (e.g. projective transform, not affine transform with triangles)
  • Update getting started guide to include a color image draw example.
  • Misc code, test and docstring cleanup

@tboch - Do you want to review this today or are you already on vacation?

@cdeil cdeil added this to the 0.1 milestone Jul 14, 2017
@cdeil cdeil self-assigned this Jul 14, 2017
@coveralls
Copy link

Coverage Status

Coverage increased (+0.3%) to 97.662% when pulling 0259b78 on cdeil:misc-cleanup into 0dcbe51 on hipspy:master.

This was referenced Jul 14, 2017
@cdeil
Copy link
Contributor Author

cdeil commented Jul 14, 2017

@tboch @adl1995 - I've added an "about" page, and updated the "drawing algo" page and done other docs changes. If you have time to review them now, please do. Otherwise I'll merge after lunch and then you can still review and comment in the coming days of course!

@cdeil
Copy link
Contributor Author

cdeil commented Jul 14, 2017

I've added an example drawing jpg from Fermi color to the high-level docs.

The result is bad:

image

I've never seen a successful RGB draw, and I don't know yet what the issue is.
@adl1995 - Have you made any progress on that yet?

If no, I would like to merge this PR after lunch, and then work on this issue in the afternoon.

@tboch
Copy link
Member

tboch commented Jul 14, 2017

@cdeil sorry, I'm already off

@coveralls
Copy link

Coverage Status

Coverage decreased (-0.7%) to 96.692% when pulling b4e045e on cdeil:misc-cleanup into 0dcbe51 on hipspy:master.

@cdeil cdeil merged commit 91f9eea into hipspy:master Jul 14, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants