Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
@eford
eford authored Mar 24, 2021
1 parent f27de7e commit 1aa9103
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
# NeidArchive [![Stable](https://img.shields.io/badge/docs-stable-blue.svg)](https://RvSpectML.github.io/NeidArchive.jl/stable) [![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://RvSpectML.github.io/NeidArchive.jl/dev) [![Build Status](https://github.com/RvSpectML/NeidArchive.jl/workflows/CI/badge.svg)](https://github.com/RvSpectML/NeidArchive.jl/actions) [![Coverage](https://codecov.io/gh/RvSpectML/NeidArchive.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/RvSpectML/NeidArchive.jl)

NeidArchive.jl is a Julia wrapper for [pyNEID](https://pyneid.readthedocs.io/en/latest/). It provides a convenient, simple API for querying and downloading data files from the [NEID archive](neid.ipac.caltech.edu) and [NEID Solar archive](https://neid.ipac.caltech.edu/search_solar.php) hosted by the [NASA Exoplanet Science Institute (NExScI)](https://nexsci.caltech.edu/).

Currently, NeidArchive.jl has limited features (i.e., what the developer needs). Please feel free to submit PRs to increase the completeness of NeidArchive.jl relative to pyNEID.

2 comments on commit 1aa9103

@eford
Copy link
Member Author

@eford eford commented on 1aa9103 Mar 24, 2021

Choose a reason for hiding this comment

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

@JuliaRegistrator register
Release Notes:

  • NeidArchive.jl is a Julia wrapper for pyNEID. It provides a convenient, simple API for querying and downloading data files from the NEID archive and NEID Solar archive hosted by the NASA Exoplanet Science Institute (NExScI).
  • Initial version provides just the basics: login, query_criteria, and download.

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

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

Registration pull request created: JuliaRegistries/General/32685

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.0 -m "<description of version>" 1aa9103da4f2c3e1de368cb749a63ae9fc44bc5a
git push origin v0.1.0

Please sign in to comment.