Skip to content

Commit

Permalink
[Documentation] Adds some notes stating that Speasy isn't a plotting …
Browse files Browse the repository at this point in the history
…package

@nicolasaunai this is for you ;)

Signed-off-by: Alexis Jeandet <alexis.jeandet@member.fsf.org>
  • Loading branch information
jeandet committed Jan 27, 2022
1 parent 450e6ed commit e5610f9
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
1 change: 1 addition & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,7 @@ Caveats
=======
- installing speasy on both python 3.7 or less and python 3.8 or plus at the same time doesn't work since entries stored
in cache by python 3.8+ are not readable by python 3.7-.
- Speasy is not a plotting package, while it provides basic plot features, it is not meant to produce publication ready figures.

Credits
========
Expand Down
8 changes: 6 additions & 2 deletions docs/user/amda/amda.rst
Original file line number Diff line number Diff line change
Expand Up @@ -166,8 +166,9 @@ Then you should get something like this:
:height: 400px
:alt: mms2_b_gse plot

Note: Depending on your matplotlib backend and if you are using Jupyter Notebooks or a simple python terminal you may
need to adapt this example.
.. note::
* Depending on your matplotlib backend and if you are using Jupyter Notebooks or a simple python terminal you may need to adapt this example.
* Speasy is not a plotting package, to produce publication ready figures, use something like matplotlib or seaborn directly.

Using timetables to download data
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down Expand Up @@ -214,6 +215,9 @@ Then you should get something like these plots:
:width: 49%
:alt: Cloud's B mean histogram

.. note::
* Depending on your matplotlib backend and if you are using Jupyter Notebooks or a simple python terminal you may need to adapt this example.
* Speasy is not a plotting package, to produce publication ready figures, use something like matplotlib or seaborn directly.

Advanced: AMDA module configuration options
-------------------------------------------
Expand Down

0 comments on commit e5610f9

Please sign in to comment.