Skip to content

Commit 6caade9

Browse files
committed
Pick readme improvments from @nicolasaunai
Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
1 parent cda2d25 commit 6caade9

File tree

5 files changed

+32
-28
lines changed

5 files changed

+32
-28
lines changed

README.ipynb

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -23,25 +23,26 @@
2323
"[![Speasy proxy uptime (30 days)](https://img.shields.io/uptimerobot/ratio/m792771930-24b7f89c03d5090a13462b70)](http://sciqlop.lpp.polytechnique.fr/cache)\n",
2424
"\n",
2525
"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",
26-
"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",
27-
"be familiar with all of the different data sources or how to access them. Speasy solves this problem by providing a single,\n",
28-
"easy-to-use interface to over 70 space missions and 65,000 products, including data from the Magnetospheric Multiscale Mission (MMS),\n",
29-
"the Advanced Composition Explorer (ACE), and the Van Allen Probes.\n",
26+
"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",
27+
"or any described archive, local or remote.\n",
28+
"This task, where any science project starts, would seem easy a priori but, considering the very\n",
29+
"diverse array of missions and instrument nowaday available, proves to be one of the major bottleneck,\n",
30+
"especially for students and newcomers.\n",
31+
"Speasy solves this problem by providing a **single, easy-to-use interface to over 70 space missions and 65,000 products**.\n",
3032
"\n",
3133
"## Main features\n",
3234
"\n",
33-
"- Simple and intuitive API (spz.get_data to get them all)\n",
34-
"- Pandas DataFrame like interface for variables\n",
35-
"- Quick functions to convert a variable to a Pandas DataFrame\n",
36-
"- Local cache to avoid repeating twice the same request\n",
37-
"- Takes advantage of SciQLop dedicated proxy as a community backed ultra fast cache\n",
35+
"- Simple and intuitive API (`spz.get_data(...)` to get them all)\n",
36+
"- Speasy variables are like Pandas DataFrame with seemless conversion to/from it.\n",
37+
"- Local cache to avoid redundant downloads\n",
38+
"- Uses the SciQLOP ultra fast community cache server\n",
3839
"- Full support of [AMDA](http://amda.irap.omp.eu/) API\n",
3940
"- Can retrieve time-series from [AMDA](http://amda.irap.omp.eu/),\n",
4041
" [CDAWeb](https://cdaweb.gsfc.nasa.gov/),\n",
4142
" [CSA](https://csa.esac.esa.int/csa-web/),\n",
4243
" [SSCWeb](https://sscweb.gsfc.nasa.gov/)\n",
43-
"- 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",
44-
"\n",
44+
"- Support data access from any local or remote archives described by YAML file.\n",
45+
" \n",
4546
"## Help us improve Speasy!\n",
4647
"\n",
4748
"We want Speasy to be the best possible tool for space physics research. You can help us by:\n",
@@ -242,9 +243,10 @@
242243
"\n",
243244
"### Caveats\n",
244245
"\n",
245-
"- Speasy is not a plotting package, while it provides basic plot\n",
246-
" features, it is not meant to produce publication ready figures.\n",
247-
"\n",
246+
"- Speasy is not a plotting package.\n",
247+
" basic plotting capabilities are here for illustration purposes and making quick-and-dirty plots.\n",
248+
" It is not meant to produce publication ready figures, prefer using Matplotlib directly for example.\n",
249+
" \n",
248250
"### Credits\n",
249251
"\n",
250252
"The development of Speasy is supported by the [CDPP](http://www.cdpp.eu/).\n",

README.md

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,25 +16,26 @@
1616
[![Speasy proxy uptime (30 days)](https://img.shields.io/uptimerobot/ratio/m792771930-24b7f89c03d5090a13462b70)](http://sciqlop.lpp.polytechnique.fr/cache)
1717

1818
Speasy is a free and open-source Python package that makes it easy to find and load space physics data from a variety of
19-
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
20-
be familiar with all of the different data sources or how to access them. Speasy solves this problem by providing a single,
21-
easy-to-use interface to over 70 space missions and 65,000 products, including data from the Magnetospheric Multiscale Mission (MMS),
22-
the Advanced Composition Explorer (ACE), and the Van Allen Probes.
19+
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/),
20+
or any described archive, local or remote.
21+
This task, where any science project starts, would seem easy a priori but, considering the very
22+
diverse array of missions and instrument nowaday available, proves to be one of the major bottleneck,
23+
especially for students and newcomers.
24+
Speasy solves this problem by providing a **single, easy-to-use interface to over 70 space missions and 65,000 products**.
2325

2426
## Main features
2527

26-
- Simple and intuitive API (spz.get_data to get them all)
27-
- Pandas DataFrame like interface for variables
28-
- Quick functions to convert a variable to a Pandas DataFrame
29-
- Local cache to avoid repeating twice the same request
30-
- Takes advantage of SciQLop dedicated proxy as a community backed ultra fast cache
28+
- Simple and intuitive API (`spz.get_data(...)` to get them all)
29+
- Speasy variables are like Pandas DataFrame with seemless conversion to/from it.
30+
- Local cache to avoid redundant downloads
31+
- Uses the SciQLOP ultra fast community cache server
3132
- Full support of [AMDA](http://amda.irap.omp.eu/) API
3233
- Can retrieve time-series from [AMDA](http://amda.irap.omp.eu/),
3334
[CDAWeb](https://cdaweb.gsfc.nasa.gov/),
3435
[CSA](https://csa.esac.esa.int/csa-web/),
3536
[SSCWeb](https://sscweb.gsfc.nasa.gov/)
36-
- 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
37-
37+
- Support data access from any local or remote archives described by YAML file.
38+
3839
## Help us improve Speasy!
3940

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

167168
### Caveats
168169

169-
- Speasy is not a plotting package, while it provides basic plot
170-
features, it is not meant to produce publication ready figures.
171-
170+
- Speasy is not a plotting package.
171+
basic plotting capabilities are here for illustration purposes and making quick-and-dirty plots.
172+
It is not meant to produce publication ready figures, prefer using Matplotlib directly for example.
173+
172174
### Credits
173175

174176
The development of Speasy is supported by the [CDPP](http://www.cdpp.eu/).

README_files/README_2_0.png

7.15 KB
Loading

README_files/README_4_0.png

7.15 KB
Loading

README_files/README_6_0.png

71.7 KB
Loading

0 commit comments

Comments
 (0)