SciQLop · jeandet · Feb 3, 2022 · Nov 4, 2021 · Jan 19, 2022 · Jan 20, 2022
diff --git a/.github/workflows/PRs.yml b/.github/workflows/PRs.yml
@@ -4,12 +4,15 @@ on: [pull_request]
 
 jobs:
   build:
+    env:
+      SPEASY_AMDA_USERNAME: ${{ secrets.SPEASY_AMDA_USERNAME }}
+      SPEASY_AMDA_PASSWORD: ${{ secrets.SPEASY_AMDA_PASSWORD }}
 
     runs-on: ubuntu-latest
     strategy:
       max-parallel: 4
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9]
+        python-version: ['3.7', '3.8', '3.9', '3.10']
 
     steps:
     - uses: actions/checkout@v2
@@ -29,13 +32,13 @@ jobs:
         flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
         # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
         flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: install texlive for Pandoc
+      run: sudo apt update && sudo apt install -y texlive pandoc && pip install wheel
     - name: Test with pytest
-      env:
-          SPEASY_AMDA_USERNAME: ${{ secrets.SPEASY_AMDA_USERNAME }}
-          SPEASY_AMDA_PASSWORD: ${{ secrets.SPEASY_AMDA_PASSWORD }}
       run: |
-        pip install pytest pytest-cov sphinx numpydoc sphinx-rtd-theme
-        SPEASY_AMDA_PASSWORD="${{ secrets.SPEASY_AMDA_PASSWORD }}" SPEASY_AMDA_USERNAME="${{ secrets.SPEASY_AMDA_USERNAME }}" pytest --cov=./ --cov-report=xml
+        pip install pytest pytest-cov sphinx pandoc
+        pip install -r docs/requirements.txt
+        pytest --cov=./ --cov-report=xml
         make doctest
     - name: Upload coverage to Codecov
       if: matrix.python-version == '3.8'

diff --git a/.github/workflows/pythonpublish.yml b/.github/workflows/pythonpublish.yml
@@ -10,7 +10,7 @@ jobs:
     strategy:
         max-parallel: 4
         matrix:
-            python-version: [3.6]
+            python-version: [3.7]
     steps:
     - uses: actions/checkout@v2
     - name: Set up Python ${{ matrix.python-version }}

diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
@@ -4,12 +4,15 @@ on: [push]
 
 jobs:
   build:
+    env:
+      SPEASY_AMDA_USERNAME: ${{ secrets.SPEASY_AMDA_USERNAME }}
+      SPEASY_AMDA_PASSWORD: ${{ secrets.SPEASY_AMDA_PASSWORD }}
 
     runs-on: ubuntu-latest
     strategy:
       max-parallel: 4
       matrix:
-        python-version: [3.6, 3.7, 3.8, 3.9]
+        python-version: ['3.7', '3.8', '3.9', '3.10']
 
     steps:
     - uses: actions/checkout@v2
@@ -29,13 +32,13 @@ jobs:
         flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
         # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
         flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: install texlive for Pandoc
+      run: sudo apt update && sudo apt install -y texlive pandoc && pip install wheel
     - name: Test with pytest
-      env:
-          SPEASY_AMDA_USERNAME: ${{ secrets.SPEASY_AMDA_USERNAME }}
-          SPEASY_AMDA_PASSWORD: ${{ secrets.SPEASY_AMDA_PASSWORD }}
       run: |
-        pip install pytest pytest-cov sphinx numpydoc sphinx-rtd-theme
-        SPEASY_AMDA_PASSWORD="${{ secrets.SPEASY_AMDA_PASSWORD }}" SPEASY_AMDA_USERNAME="${{ secrets.SPEASY_AMDA_USERNAME }}" pytest --cov=./ --cov-report=xml
+        pip install pytest pytest-cov sphinx pandoc
+        pip install -r docs/requirements.txt
+        pytest --cov=./ --cov-report=xml
         make doctest
     - name: Upload coverage to Codecov
       if: matrix.python-version == '3.8'

diff --git a/.gitignore b/.gitignore
@@ -103,3 +103,19 @@ ENV/
 
 # IDE
 .idea/
+
+#auto generated doc files
+/docs/dev/modules.rst
+/docs/dev/speasy.common.rst
+/docs/dev/speasy.config.rst
+/docs/dev/speasy.core.cache.rst
+/docs/dev/speasy.core.proxy.rst
+/docs/dev/speasy.core.rst
+/docs/dev/speasy.inventory.rst
+/docs/dev/speasy.products.rst
+/docs/dev/speasy.rst
+/docs/dev/speasy.webservices.amda.rst
+/docs/dev/speasy.webservices.cda.rst
+/docs/dev/speasy.webservices.csa.rst
+/docs/dev/speasy.webservices.rst
+/docs/dev/speasy.webservices.ssc.rst
diff --git a/CITATION.cff b/CITATION.cff
@@ -0,0 +1,11 @@
+@software{alexis_jeandet_2021_5727877,
+  author       = {Alexis Jeandet and
+                  Alexandre Schulz},
+  title        = {{SciQLop/speasy: 0.9.1)}},
+  month        = nov,
+  year         = 2021,
+  publisher    = {Zenodo},
+  version      = {v0.9.1},
+  doi          = {10.5281/zenodo.5727877},
+  url          = {https://doi.org/10.5281/zenodo.5727877}
+}
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -2,6 +2,23 @@
 History
 =======
 
+0.9.1 (2021-11-25)
+==================
+
+* Fix AMDA module bug `#24 downloading multidimensional data fails <https://github.com/SciQLop/speasy/issues/24>`_
+
+0.9.0 (2021-07-29)
+==================
+
+* Adds SPWC migration tool
+* Rename SpwcVariable to SpeasyVariable
+
+0.8.3 (2021-07-28)
+==================
+
+* Package renamed from SPWC to SPEASY
+* Some doc and CI improvements
+
 0.8.2 (2021-04-20)
 ==================
 

diff --git a/Makefile b/Makefile
@@ -69,9 +69,9 @@ coverage: ## check code coverage quickly with the default Python
 	$(BROWSER) htmlcov/index.html
 
 docs: ## generate Sphinx HTML documentation, including API docs
-	rm -f docs/speasy.rst
-	rm -f docs/modules.rst
-	sphinx-apidoc -M -o docs/ speasy
+	rm -f docs/dev/speasy.rst
+	rm -f docs/dev/modules.rst
+	#sphinx-apidoc -M -o docs/dev speasy
 	$(MAKE) -C docs clean
 	$(MAKE) -C docs html
 	$(BROWSER) docs/_build/html/index.html

diff --git a/README.rst b/README.rst
@@ -34,7 +34,7 @@ Space Physics made EASY
    :alt: Zendoo DOI
 
 .. image:: https://mybinder.org/badge_logo.svg
-    :target: https://mybinder.org/v2/gh/SciQLop/spwc/HEAD?filepath=examples%2Fdemo.ipynb
+    :target: https://mybinder.org/v2/gh/SciQLop/speasy/main?labpath=docs/examples
     :alt: Discover on MyBinder
 
 Speasy is an open source Python client for Space Physics web services such as `CDAWEB <https://cdaweb.gsfc.nasa.gov/index.html/>`_
@@ -47,7 +47,7 @@ Speasy aims to support as much as possible web services and also cover a maximum
 Quickstart
 ----------
 
-Installing Speasy with pip (:doc:`more details here <installation>`):
+Installing Speasy with pip (`more details here <https://speasy.readthedocs.io/en/stable/installation.html>`_):
 
 .. code-block:: console
 
@@ -99,7 +99,13 @@ Features
 
 Examples
 ========
-See `here <https://nbviewer.jupyter.org/github/SciQLop/speasy/blob/main/examples/demo.ipynb>`_ for a complete list of examples.
+See `here <https://speasy.readthedocs.io/en/stable/examples/index.html`_ for a complete list of examples.
+
+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
 ========
@@ -108,3 +114,5 @@ This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypack
 
 .. _Cookiecutter: https://github.com/audreyr/cookiecutter
 .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
+
+The development of speasy is supported by the `CDPP <http://www.cdpp.eu/>`_.
diff --git a/docs/_static/AMDA_nb_thumbnail.png b/docs/_static/AMDA_nb_thumbnail.png
diff --git a/docs/_static/Caches_nb_thumbnail.png b/docs/_static/Caches_nb_thumbnail.png
diff --git a/docs/_static/SSCWEB_nb_thumbnail.png b/docs/_static/SSCWEB_nb_thumbnail.png
diff --git a/docs/amda.rst b/docs/amda.rst
diff --git a/docs/amda_catalogs.rst b/docs/amda_catalogs.rst
diff --git a/docs/amda_datasets.rst b/docs/amda_datasets.rst
diff --git a/docs/amda_example_1.rst b/docs/amda_example_1.rst
diff --git a/docs/amda_example_2.rst b/docs/amda_example_2.rst