Merge pull request #1655 from modflowpy/v3.3.6

Release 3.3.6

.docs/conf.py

@@ -13,6 +13,8 @@
 import os
 import sys
 
+import yaml
+
 # add flopy root directory to the python path
 sys.path.insert(0, os.path.abspath(".."))
 from flopy import __author__, __version__
@@ -30,6 +32,10 @@
             rc_text = "release candidate"
         break
 
+# -- get authors
+with open("../CITATION.cff") as f:
+    citation = yaml.safe_load(f.read())
+
 # -- update version number in main.rst
 rst_name = "main.rst"
 with open(rst_name, "r") as f:
@@ -62,10 +68,21 @@
                 "post-processing.  Members of the team\n"
                 "currently include:\n\n"
             )
-            authors = __author__.split(sep=",")
-            for author in authors:
-                line += f" * {author.strip()}\n"
+            image_directives = ""
+            orcid_image = "_images/orcid_16x16.png"
+            parts = ["given-names", "name-particle", "family-names", "name"]
+            for author in citation["authors"]:
+                name = " ".join([author[pt] for pt in parts if pt in author])
+                line += f" * {name}"
+                if "orcid" in author:
+                    tag = "orcid_" + name.replace(" ", "_").replace(".", "")
+                    line += f" |{tag}|"
+                    image_directives += f".. |{tag}| image:: {orcid_image}\n"
+                    image_directives += f"   :target: {author['orcid']}\n"
+                line += "\n"
             line += " * and others\n\n"
+            line += image_directives
+            line += "\n"
             f.write(line)
         elif line.startswith(tag_end):
             write_line = True
@@ -90,14 +107,14 @@
     os.system(" ".join(cmd))
 
 # -- Project information -----------------------------------------------------
-project = "flopy Documentation"
-copyright = f"2021, {__author__}"
+project = "FloPy Documentation"
+copyright = f"2022, {__author__}"
 author = __author__
 
 # The version.
 version = __version__
 release = __version__
-language = None
+language = "en"
 
 # -- General configuration ---------------------------------------------------
 

.docs/introduction.rst

@@ -58,6 +58,14 @@ To install the bleeding edge version of FloPy from the git repository type:
 
     pip install git+https://github.com/modflowpy/flopy.git
 
+After FloPy is installed, MODFLOW and related programs can be installed using the command:
+
+.. code-block:: bash
+
+    get-modflow :flopy
+
+See documentation `get_modflow.md <https://github.com/modflowpy/flopy/blob/develop/docs/get_modflow.md>`_
+for more information.
 
 
 FloPy Resources
@@ -77,22 +85,49 @@ FloPy is developed by a team of MODFLOW users that have switched over to using
 Python for model development and post-processing.  Members of the team
 currently include:
 
- * Mark Bakker
- * Vincent Post
- * Joseph D. Hughes
- * Christian D. Langevin
- * Jeremy T. White
- * Andrew T. Leaf
- * Scott R. Paulinski
- * Jason C. Bellino
- * Eric D. Morway
- * Michael W. Toews
- * Joshua D. Larsen
- * Michael N. Fienen
- * Jon Jeffrey Starn
+ * Mark Bakker |orcid_Mark_Bakker|
+ * Vincent Post |orcid_Vincent_Post|
+ * Joseph D. Hughes |orcid_Joseph_D_Hughes|
+ * Christian D. Langevin |orcid_Christian_D_Langevin|
+ * Jeremy T. White |orcid_Jeremy_T_White|
+ * Andrew T. Leaf |orcid_Andrew_T_Leaf|
+ * Scott R. Paulinski |orcid_Scott_R_Paulinski|
+ * Jason C. Bellino |orcid_Jason_C_Bellino|
+ * Eric D. Morway |orcid_Eric_D_Morway|
+ * Michael W. Toews |orcid_Michael_W_Toews|
+ * Joshua D. Larsen |orcid_Joshua_D_Larsen|
+ * Michael N. Fienen |orcid_Michael_N_Fienen|
+ * Jon Jeffrey Starn |orcid_Jon_Jeffrey_Starn|
  * Davíd Brakenhoff
  * and others
 
+.. |orcid_Mark_Bakker| image:: _images/orcid_16x16.png
+   :target: https://orcid.org/0000-0002-5629-2861
+.. |orcid_Vincent_Post| image:: _images/orcid_16x16.png
+   :target: https://orcid.org/0000-0002-9463-3081
+.. |orcid_Joseph_D_Hughes| image:: _images/orcid_16x16.png
+   :target: https://orcid.org/0000-0003-1311-2354
+.. |orcid_Christian_D_Langevin| image:: _images/orcid_16x16.png
+   :target: https://orcid.org/0000-0001-5610-9759
+.. |orcid_Jeremy_T_White| image:: _images/orcid_16x16.png
+   :target: https://orcid.org/0000-0002-4950-1469
+.. |orcid_Andrew_T_Leaf| image:: _images/orcid_16x16.png
+   :target: https://orcid.org/0000-0001-8784-4924
+.. |orcid_Scott_R_Paulinski| image:: _images/orcid_16x16.png
+   :target: https://orcid.org/0000-0001-6548-8164
+.. |orcid_Jason_C_Bellino| image:: _images/orcid_16x16.png
+   :target: https://orcid.org/0000-0001-9046-9344
+.. |orcid_Eric_D_Morway| image:: _images/orcid_16x16.png
+   :target: https://orcid.org/0000-0002-8553-6140
+.. |orcid_Michael_W_Toews| image:: _images/orcid_16x16.png
+   :target: https://orcid.org/0000-0003-3657-7963
+.. |orcid_Joshua_D_Larsen| image:: _images/orcid_16x16.png
+   :target: https://orcid.org/0000-0002-1218-800X
+.. |orcid_Michael_N_Fienen| image:: _images/orcid_16x16.png
+   :target: https://orcid.org/0000-0002-7756-4651
+.. |orcid_Jon_Jeffrey_Starn| image:: _images/orcid_16x16.png
+   :target: https://orcid.org/0000-0001-5909-0010
+
 How to Cite
 ===========
 

.docs/make.bat

@@ -21,7 +21,7 @@ if errorlevel 9009 (
 	echo.may add the Sphinx directory to PATH.
 	echo.
 	echo.If you don't have Sphinx installed, grab it from
-	echo.http://sphinx-doc.org/
+	echo.https://www.sphinx-doc.org/
 	exit /b 1
 )
 

.docs/tutorials.rst

@@ -28,6 +28,7 @@ Contents:
    _notebooks/tutorial06_mf6_data
    _notebooks/tutorial07_mf6_data
    _notebooks/tutorial08_mf6_data
+   _notebooks/tutorial09_mf6_data
 
 
 MODFLOW 6 Output Tutorials
@@ -53,18 +54,6 @@ Contents:
    _notebooks/tutorial02_mf
 
 
-.IPYNB_CHECKPOINTS Tutorials
-----------------------------
-
-Contents:
-
-.. toctree::
-   :maxdepth: 2
-
-   _notebooks/tutorial01_mf-checkpoint
-   _notebooks/tutorial02_mf-checkpoint
-
-
 SEAWAT Tutorials
 ----------------
 

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: 'bug: '
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: 'feature: '
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.