-
-
Notifications
You must be signed in to change notification settings - Fork 425
new tool: HITRAN database #617
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
Conversation
|
This is working well. Any chance to have this PR merged? |
|
Yeah, but it would be best to have tests. I don't even remember writing this code, but blame says I did... |
|
Can't agree more with @keflavich, tests would be nice, and at least a very basic narrative docs page to show the usage of it. |
|
I will add some tests for the read_hitran_file function. |
|
Once this passes, since we now have at least basic docs and tests, I'm happy to merge it. @migueldvb, let me know if there's more you'd like to add first. |
|
Oh, we should add:
|
docs/hitran/hitran.rst
Outdated
|
|
||
| This module provides an interface to the `HITRAN`_ database API. It can | ||
| download a data file including transitions for a particular molecule in a given | ||
| wavenumber range. The file is downloaded in the `~hitran.cache_location` |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You need to use the full path to make sphinx resolve it as an API link, e.g. ~astroquery.hitran.cache_location. Warnings for unresolvable links cause the build to fail.
| ======== | ||
|
|
||
| This will download all transitions of the main isotopologue of water between | ||
| the wavenumbers of 3400 and 4100 cm\ :sup:`-1`\ . |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Does this work for you locally? Singe backticks are special for sphinx, probably you will need to use double backticks here
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is working for me with sphinx 1.4.8
Thanks to @bsipocz
This fixes a sphinx warning
Give cache directory path in HITRAN docs
|
There is a travis error that should not be related with these changes. |
|
This should probably affect other affiliated packages too. If we can get this fixed (or confirm that it's not something we should fix within astroquery), I think this is ready to merge. EDIT: I restarted that build. |
|
@keflavich - This is a weird issue (haven't seen it with other packages yet), and definitely has nothing to do with this PR. |
|
@bsipocz OK, thanks for raising the aplpy issue. I think we'll mark this as 'xfail' and merge if we can't find a solution quickly, but with a note that we should unmark xfail once we figure out what's going on. |
|
I probably have a workaround, but still waiting for travis to pass on it. I can hit the merge button on this if you prefer, or you can also add the failing build to the |
|
Travis passed, so I'm merging this. |
|
@keflavich - Any particular reason for this module not following the common class API? Noticed while trying to get rid of the usage of commons.send_request() in favour of self._request... |
|
@bsipocz no. probably just used the outdated template. |
WIP: so far only a reader is implemented.
The HITRAN database (https://www.cfa.harvard.edu/hitran/) includes molecular line parameters and is more extensive than splatalogue, in particular including infrared transitions.