Skip to content

Commit

Permalink
Pick readme improvments from @nicolasaunai
Browse files Browse the repository at this point in the history
Signed-off-by: Alexis Jeandet <[email protected]>
  • Loading branch information
jeandet committed Oct 31, 2023
1 parent cda2d25 commit 6caade9
Show file tree
Hide file tree
Showing 5 changed files with 32 additions and 28 deletions.
30 changes: 16 additions & 14 deletions README.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -23,25 +23,26 @@
"[![Speasy proxy uptime (30 days)](https://img.shields.io/uptimerobot/ratio/m792771930-24b7f89c03d5090a13462b70)](http://sciqlop.lpp.polytechnique.fr/cache)\n",
"\n",
"Speasy is a free and open-source Python package that makes it easy to find and load space physics data from a variety of\n",
"online data sources, such as [CDAWEB](https://cdaweb.gsfc.nasa.gov/index.html/) and [AMDA](http://amda.irap.omp.eu/). This can be difficult, especially for students and newcomers, who may not\n",
"be familiar with all of the different data sources or how to access them. Speasy solves this problem by providing a single,\n",
"easy-to-use interface to over 70 space missions and 65,000 products, including data from the Magnetospheric Multiscale Mission (MMS),\n",
"the Advanced Composition Explorer (ACE), and the Van Allen Probes.\n",
"data sources, whether it is online and public such as [CDAWEB](https://cdaweb.gsfc.nasa.gov/index.html/) and [AMDA](http://amda.irap.omp.eu/),\n",
"or any described archive, local or remote.\n",
"This task, where any science project starts, would seem easy a priori but, considering the very\n",
"diverse array of missions and instrument nowaday available, proves to be one of the major bottleneck,\n",
"especially for students and newcomers.\n",
"Speasy solves this problem by providing a **single, easy-to-use interface to over 70 space missions and 65,000 products**.\n",
"\n",
"## Main features\n",
"\n",
"- Simple and intuitive API (spz.get_data to get them all)\n",
"- Pandas DataFrame like interface for variables\n",
"- Quick functions to convert a variable to a Pandas DataFrame\n",
"- Local cache to avoid repeating twice the same request\n",
"- Takes advantage of SciQLop dedicated proxy as a community backed ultra fast cache\n",
"- Simple and intuitive API (`spz.get_data(...)` to get them all)\n",
"- Speasy variables are like Pandas DataFrame with seemless conversion to/from it.\n",
"- Local cache to avoid redundant downloads\n",
"- Uses the SciQLOP ultra fast community cache server\n",
"- Full support of [AMDA](http://amda.irap.omp.eu/) API\n",
"- Can retrieve time-series from [AMDA](http://amda.irap.omp.eu/),\n",
" [CDAWeb](https://cdaweb.gsfc.nasa.gov/),\n",
" [CSA](https://csa.esac.esa.int/csa-web/),\n",
" [SSCWeb](https://sscweb.gsfc.nasa.gov/)\n",
"- Archive module for accessing data from a local or remote archive without any webservice, using a simple YAML file to describe the archive file tree\n",
"\n",
"- Support data access from any local or remote archives described by YAML file.\n",
" \n",
"## Help us improve Speasy!\n",
"\n",
"We want Speasy to be the best possible tool for space physics research. You can help us by:\n",
Expand Down Expand Up @@ -242,9 +243,10 @@
"\n",
"### Caveats\n",
"\n",
"- Speasy is not a plotting package, while it provides basic plot\n",
" features, it is not meant to produce publication ready figures.\n",
"\n",
"- Speasy is not a plotting package.\n",
" basic plotting capabilities are here for illustration purposes and making quick-and-dirty plots.\n",
" It is not meant to produce publication ready figures, prefer using Matplotlib directly for example.\n",
" \n",
"### Credits\n",
"\n",
"The development of Speasy is supported by the [CDPP](http://www.cdpp.eu/).\n",
Expand Down
30 changes: 16 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,25 +16,26 @@
[![Speasy proxy uptime (30 days)](https://img.shields.io/uptimerobot/ratio/m792771930-24b7f89c03d5090a13462b70)](http://sciqlop.lpp.polytechnique.fr/cache)

Speasy is a free and open-source Python package that makes it easy to find and load space physics data from a variety of
online data sources, such as [CDAWEB](https://cdaweb.gsfc.nasa.gov/index.html/) and [AMDA](http://amda.irap.omp.eu/). This can be difficult, especially for students and newcomers, who may not
be familiar with all of the different data sources or how to access them. Speasy solves this problem by providing a single,
easy-to-use interface to over 70 space missions and 65,000 products, including data from the Magnetospheric Multiscale Mission (MMS),
the Advanced Composition Explorer (ACE), and the Van Allen Probes.
data sources, whether it is online and public such as [CDAWEB](https://cdaweb.gsfc.nasa.gov/index.html/) and [AMDA](http://amda.irap.omp.eu/),
or any described archive, local or remote.
This task, where any science project starts, would seem easy a priori but, considering the very
diverse array of missions and instrument nowaday available, proves to be one of the major bottleneck,
especially for students and newcomers.
Speasy solves this problem by providing a **single, easy-to-use interface to over 70 space missions and 65,000 products**.

## Main features

- Simple and intuitive API (spz.get_data to get them all)
- Pandas DataFrame like interface for variables
- Quick functions to convert a variable to a Pandas DataFrame
- Local cache to avoid repeating twice the same request
- Takes advantage of SciQLop dedicated proxy as a community backed ultra fast cache
- Simple and intuitive API (`spz.get_data(...)` to get them all)
- Speasy variables are like Pandas DataFrame with seemless conversion to/from it.
- Local cache to avoid redundant downloads
- Uses the SciQLOP ultra fast community cache server
- Full support of [AMDA](http://amda.irap.omp.eu/) API
- Can retrieve time-series from [AMDA](http://amda.irap.omp.eu/),
[CDAWeb](https://cdaweb.gsfc.nasa.gov/),
[CSA](https://csa.esac.esa.int/csa-web/),
[SSCWeb](https://sscweb.gsfc.nasa.gov/)
- Archive module for accessing data from a local or remote archive without any webservice, using a simple YAML file to describe the archive file tree

- Support data access from any local or remote archives described by YAML file.
## Help us improve Speasy!

We want Speasy to be the best possible tool for space physics research. You can help us by:
Expand Down Expand Up @@ -166,9 +167,10 @@ Check out [Speasy documentation](https://speasy.readthedocs.io/en/stable/) and [

### Caveats

- Speasy is not a plotting package, while it provides basic plot
features, it is not meant to produce publication ready figures.

- Speasy is not a plotting package.
basic plotting capabilities are here for illustration purposes and making quick-and-dirty plots.
It is not meant to produce publication ready figures, prefer using Matplotlib directly for example.

### Credits

The development of Speasy is supported by the [CDPP](http://www.cdpp.eu/).
Expand Down
Binary file modified README_files/README_2_0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified README_files/README_4_0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified README_files/README_6_0.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6caade9

Please sign in to comment.