Skip to content

Commit

Permalink
Update README.rst (#97)
Browse files Browse the repository at this point in the history
  • Loading branch information
nabobalis authored Sep 11, 2023
1 parent f34ddbc commit e362e92
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 47 deletions.
42 changes: 0 additions & 42 deletions .github/workflows/changelog_bot.yml

This file was deleted.

11 changes: 6 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,14 @@
``sunpy-soar``
**************

|build-status| |coverage|
|ci-status| |coverage|

.. |build-status| image:: https://github.com/dstansby/sunpy-soar/actions/workflows/python-test.yml/badge.svg
:alt: build status
.. |ci-status| image:: https://github.com/sunpy/sunpy-soar/actions/workflows/ci.yml/badge.svg
:alt: CI status

.. |coverage| image:: https://codecov.io/gh/dstansby/sunpy-soar/branch/main/graph/badge.svg?token=5NKZHBX3AW
:target: https://codecov.io/gh/dstansby/sunpy-soar
:alt: code coverage

:alt: Code coverage

.. note::

Expand All @@ -21,6 +20,7 @@ A sunpy Fido plugin for accessing data in the Solar Orbiter Archive (SOAR).

Installation
------------

``sunpy-soar`` requires ``python >= 3.9`` and `sunpy >= 5.0`.
Currently it can only be installed from PyPI using:

Expand Down Expand Up @@ -62,6 +62,7 @@ The code below gives an example of how to search and download Solar Orbiter data
Available search attributes
---------------------------

The easiest way to access search attributes is using ``import sunpy.net.attrs as a``.
When constructing a search for SOAR ``a.Time`` must be provided.
Other search attributes can be used too - ``sunpy-soar`` recognises the following:
Expand Down

0 comments on commit e362e92

Please sign in to comment.