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

Add offset function #34

Merged
merged 10 commits into from
Apr 17, 2020
Merged

Add offset function #34

merged 10 commits into from
Apr 17, 2020

Conversation

mileslucas
Copy link
Member

@mileslucas mileslucas commented Apr 7, 2020

This PR adds two functions called offset. The first takes a coordinate, separation in rad, and position angle in rad and returns another coordinate. This is equivalent to the SkyCoord.directional_offset_by method. The other version takes two sky coordinates and returns a tuple of the separation and position angle.

Docs have been added, along with tests for accuracy, type stability, and integration (finding the offset between two coords and then offsetting one should return the other). Doc preview should show up at https://juliaastro.github.io/SkyCoords.jl/previews/PR34.

I've also bumped package version to 0.6.0 so we can release after this is merged.

@mileslucas mileslucas requested a review from giordano April 7, 2020 00:55
@codecov-io
Copy link

codecov-io commented Apr 7, 2020

Codecov Report

Merging #34 into master will increase coverage by 2.91%.
The diff coverage is 100.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master      #34      +/-   ##
==========================================
+ Coverage   96.22%   99.13%   +2.91%     
==========================================
  Files           2        2              
  Lines         106      116      +10     
==========================================
+ Hits          102      115      +13     
+ Misses          4        1       -3     
Impacted Files Coverage Δ
src/SkyCoords.jl 98.92% <100.00%> (+1.33%) ⬆️
src/types.jl 100.00% <0.00%> (+8.69%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 27b4ece...20d1641. Read the comment docs.

@@ -1,7 +1,7 @@
name = "SkyCoords"
uuid = "fc659fc5-75a3-5475-a2ea-3da92c065361"
authors = "Kyle Barbary, Mosé Giordano, and contributors"
version = "0.5.0"
version = "0.6.0"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd go to v1.0 at this point. The main API is quite stable, we usually only add new features

Copy link
Member Author

@mileslucas mileslucas Apr 15, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm, I disagree. I think #6 needs to be decided on, since it could change the API.

@giordano giordano merged commit 5a761d6 into master Apr 17, 2020
@giordano giordano deleted the offset branch April 17, 2020 20:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants