Merge pull request #53 from IMMM-SFA/joss-review

Joss review

.github/workflows/build_linux.yml

@@ -28,7 +28,14 @@ jobs:
             python -m pip install --upgrade pip
             pip install .
 
-        - name: Test
+        - name: Test and generate coverage report
           run: |
             pip install pytest
-            pytest
+            pip install pytest-cov
+            pytest --cov=./ --cov-report=xml
+
+        - name: Upload coverage to Codecov
+          uses: codecov/codecov-action@v1
+          with:
+            file: ./coverage.xml
+            fail_ci_if_error: true

.github/workflows/build_osx.yml

@@ -1,6 +1,6 @@
 name: osx
 
-on: [push]
+on: [pull_request]
 
 jobs:
   build:
@@ -28,14 +28,7 @@ jobs:
             python -m pip install --upgrade pip
             pip install .
 
-        - name: Test and generate coverage report
+        - name: Test
           run: |
             pip install pytest
-            pip install pytest-cov
-            pytest --cov=./ --cov-report=xml
-
-        - name: Upload coverage to Codecov
-          uses: codecov/codecov-action@v1
-          with:
-            file: ./coverage.xml
-            fail_ci_if_error: true
+            pytest

.github/workflows/build_windows.yml

@@ -1,6 +1,6 @@
 name: windows
 
-on: [push]
+on: [pull_request]
 
 jobs:
   build:

README.md

@@ -13,7 +13,7 @@ pip install mosartwmpy
 
 Alternatively, install via conda with:
 ```shell
-conda install mosartwmpy
+conda install -c conda-forge mosartwmpy
 ```
 
 Download a sample input dataset spanning May 1981 by running the following and selecting option `1` for "tutorial". This will download and unpack the inputs to your current directory. Optionally specify a path to download and extract to instead of the current directory.

docs/conf.py

@@ -31,6 +31,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    'nbsphinx',
     'recommonmark',                                                             
     'sphinx.ext.napoleon',                                                      
     'sphinx.ext.autodoc',                                                       

docs/index.rst

@@ -5,9 +5,16 @@ Introduction
 ------------
 .. toctree::
    :maxdepth: 1
-   
+
    README.md
 
+Tutorial
+--------
+.. toctree::
+   :maxdepth: 1
+
+   tutorial.ipynb
+
 Tips and Tricks
 ---------------
 .. toctree::

docs/tutorial.ipynb

@@ -0,0 +1 @@
+../notebooks/tutorial.ipynb

setup.cfg

@@ -1,2 +1,2 @@
 [metadata]
-description-file = README.md
+description_file = README.md

setup.py

@@ -9,7 +9,7 @@ def readme():
 
 setup(
     name='mosartwmpy',
-    version='0.0.6',
+    version='0.0.7',
     packages=find_packages(),
     url='https://github.com/IMMM-SFA/mosartwmpy',
     license='BSD2-Simplified',
@@ -23,6 +23,7 @@ def readme():
     install_requires=[
         'bmipy==2.0',
         'dask[complete]==2021.5.1',
+        'ipython==7.24.1',
         'matplotlib==3.4.2',
         'nc-time-axis==1.2.0',
         'netCDF4==1.5.6',
@@ -42,6 +43,7 @@ def readme():
     extras_require={
         'dev': [
             'build==0.4.0',
+            'nbsphinx==0.8.6',
             'recommonmark==0.7.1',
             'setuptools==54.1.2',
             'sphinx==3.5.2',