Geopy 1573

.azure-pipelines/matrix.yml

@@ -3,7 +3,7 @@ parameters:
   py_vers: ['3.8']
   test: ['tests/em',
          'tests/base tests/flow tests/seis tests/utils tests/meta',
-         'tests/docs',
+         'tests/docs -s -v',
          'tests/examples/test_examples_1.py',
          'tests/examples/test_examples_2.py',
          'tests/examples/test_examples_3.py',
@@ -21,7 +21,17 @@ jobs:
           displayName: ${{ os }}_${{ py_vers }}_${{ test }}
           pool:
             vmImage: ${{ os }}
+          timeoutInMinutes: 120
           steps:
+
+          # Checkout simpeg repo, including tags.
+          # We need to sync tags and disable shallow depth in order to get the
+          # SimPEG version while building the docs.
+          - checkout: self
+            fetchDepth: 0
+            fetchTags: true
+            displayName: Checkout repository (including tags)
+
           - script: |
               wget -O Mambaforge.sh  "https://github.com/conda-forge/miniforge/releases/latest/download/Mambaforge-$(uname)-$(uname -m).sh"
               bash Mambaforge.sh -b -p "${HOME}/conda"
@@ -30,10 +40,14 @@ jobs:
           - script: |
               source "${HOME}/conda/etc/profile.d/conda.sh"
               source "${HOME}/conda/etc/profile.d/mamba.sh"
-              echo "  - python="${{ py_vers }} >> environment_test.yml
-              mamba env create -f environment_test.yml
+              cp environment_test.yml environment_test_with_pyversion.yml
+              echo "  - python="${{ py_vers }} >> environment_test_with_pyversion.yml
+              mamba env create -f environment_test_with_pyversion.yml
+              rm environment_test_with_pyversion.yml
               conda activate simpeg-test
               pip install pytest-azurepipelines
+              echo "\nList installed packages"
+              conda list
             displayName: Create Anaconda testing environment
 
           - script: |
@@ -42,13 +56,26 @@ jobs:
               pip install -e .
             displayName: Build package
 
+          - script: |
+              source "${HOME}/conda/etc/profile.d/conda.sh"
+              conda activate simpeg-test
+              python -c "import simpeg; print(simpeg.__version__)"
+            displayName: Check SimPEG version
+
           - script: |
               source "${HOME}/conda/etc/profile.d/conda.sh"
               conda activate simpeg-test
               export KMP_WARNINGS=0
-              pytest ${{ test }} --cov-config=.coveragerc --cov=SimPEG --cov-report=xml --cov-report=html -W ignore::DeprecationWarning
+              pytest ${{ test }} -v --cov-config=.coveragerc --cov=simpeg --cov-report=xml --cov-report=html -W ignore::DeprecationWarning
             displayName: 'Testing ${{ test }}'
 
+          - task: PublishPipelineArtifact@1
+            inputs:
+              targetPath: $(Build.SourcesDirectory)/docs/_build/html
+              artifactName: html_docs
+            displayName: 'Publish documentation artifact'
+            condition: eq('${{ test }}', 'tests/docs -s -v')
+
           - script: |
               curl -Os https://uploader.codecov.io/latest/linux/codecov
               chmod +x codecov

.coveragerc

@@ -1,4 +1,4 @@
 [run]
-source = SimPEG
+source = simpeg
 omit =
     */setup.py

.flake8

@@ -6,6 +6,8 @@
 # ----------------
 [flake8]
 extend-ignore =
+    # Default ignores by flake (added here for when ignore gets overwritten)
+    E121,E123,E126,E226,E24,E704,W503,W504,
     # Too many leading '#' for block comment
     E266,
     # Line too long (82 > 79 characters)
@@ -20,12 +22,97 @@ exclude =
     .git,
     __pycache__,
     .ipynb_checkpoints,
+    setup.py,
+    docs/conf.py,
+    docs/_build/,
 per-file-ignores =
     # disable unused-imports errors on __init__.py
     __init__.py: F401
 exclude-from-doctest =
     # Don't check style in docstring of test functions
     tests
+# Define flake rules that will be ignored for now. Every time a new warning is
+# solved througout the entire project, it should be removed to this list.
+ignore =
+    # assertRaises(Exception): should be considered evil
+    B017,
+    # Missing docstring in public module
+    D100,
+    # Missing docstring in public class
+    D101,
+    # Missing docstring in public method
+    D102,
+    # Missing docstring in public function
+    D103,
+    # Missing docstring in public package
+    D104,
+    # Missing docstring in magic method
+    D105,
+    # Missing docstring in __init__
+    D107,
+    # One-line docstring should fit on one line with quotes
+    D200,
+    # No blank lines allowed before function docstring
+    D201,
+    # No blank lines allowed after function docstring
+    D202,
+    # 1 blank line required between summary line and description
+    D205,
+    # Docstring is over-indented
+    D208,
+    # Multi-line docstring closing quotes should be on a separate line
+    D209,
+    # No whitespaces allowed surrounding docstring text
+    D210,
+    # No blank lines allowed before class docstring
+    D211,
+    # Use """triple double quotes"""
+    D300,
+    # First line should end with a period
+    D400,
+    # First line should be in imperative mood; try rephrasing
+    D401,
+    # First line should not be the function's "signature"
+    D402,
+    # First word of the first line should be properly capitalized
+    D403,
+    # No blank lines allowed between a section header and its content
+    D412,
+    # Section has no content
+    D414,
+    # Docstring is empty
+    D419,
+    # module level import not at top of file
+    E402,
+    # undefined name %r
+    F821,
+    # Block quote ends without a blank line; unexpected unindent.
+    RST201,
+    # Definition list ends without a blank line; unexpected unindent.
+    RST203,
+    # Field list ends without a blank line; unexpected unindent.
+    RST206,
+    # Inline strong start-string without end-string.
+    RST210,
+    # Title underline too short.
+    RST212,
+    # Inline emphasis start-string without end-string.
+    RST213,
+    # Inline interpreted text or phrase reference start-string without end-string.
+    RST215,
+    # Inline substitution_reference start-string without end-string.
+    RST219,
+    # Unexpected indentation.
+    RST301,
+    # Unknown directive type "*".
+    RST303,
+    # Unknown interpreted text role "*".
+    RST304,
+    # Error in "*" directive:
+    RST307,
+    # Previously unseen severe error, not yet assigned a unique code.
+    RST499,
+
 
 # Configure flake8-rst-docstrings
 # -------------------------------

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -7,7 +7,7 @@ body:
 - type: markdown
   attributes:
     value: >
-      Thanks for your use of SimPEG and for taking the time to report a bug! Please
+      Thanks for using SimPEG and taking the time to report a bug! Please
       first double check that there is not already a bug report on this issue by
       searching through the existing bugs.
 
@@ -19,13 +19,13 @@ body:
 
 - type: textarea
   attributes:
-    label: "Reproducable code example:"
+    label: "Reproducible code example:"
     description: >
       Please submit a small, but complete, code sample that reproduces the
       bug or missing functionality. It should be able to be copy-pasted
-      into a Python interpreter and ran as-is.
+      into a Python interpreter and run as-is.
     placeholder: |
-      import SimPEG
+      import simpeg
       << your code here >>
     render: python
   validations:
@@ -44,8 +44,8 @@ body:
   attributes:
     label: "Runtime information:"
     description: >
-      Please include the output from `SimPEG.Report()` to describe your system for us.
-      Paste the output from `from SimPEG import Report; print(Report())` below.
+      Please include the output from `simpeg.Report()` to describe your system for us.
+      Paste the output from `from simpeg import Report; print(Report())` below.
   validations:
     required: true
 
@@ -58,4 +58,4 @@ body:
     placeholder: |
       << your explanation here >>
   validations:
-    required: false
+    required: false

.github/ISSUE_TEMPLATE/config.yml

@@ -3,5 +3,5 @@ contact_links:
     url: https://simpeg.discourse.group/
     about: "If you have a question on how to use SimPEG, please submit them to our discourse page."
   - name: Development-related matters
-    url: http://slack.simpeg.xyz/
-    about: "If you would like to discuss SimPEG, any geophysics related problems, or need help from the SimPEG team, get in touch with us on slack."
+    url: https://mattermost.softwareunderground.org/simpeg
+    about: "If you would like to discuss SimPEG, any geophysics related problems, or need help from the SimPEG team, get in touch with us on Mattermost."

.github/ISSUE_TEMPLATE/feature-request.yml

@@ -6,16 +6,17 @@ body:
 - type: markdown
   attributes:
     value: >
-      If you'd like to request a new feature in SimPEG, or suggest changes in the
-      functionality of certain functions, we recommend getting in touch with the
-      developers on [slack](https://slack.simpeg.xyz), in addition to opening an
-      issue or pull request here.
+      If you'd like to request a new feature in SimPEG, or suggest changes in
+      the functionality of certain functions, we recommend getting in touch
+      with the developers on
+      [Mattermost](https://mattermost.softwareunderground.org/simpeg), in
+      addition to opening an Issue or Pull Request here.
       You can also check out our
-      [Contributor Guide](https://docs.simpeg.xyz/content/basic/contributing.html)
+      [Contributor Guide](https://docs.simpeg.xyz/content/getting_started/contributing/index.html)
       if you need more information.
 
 - type: textarea
   attributes:
     label: "Proposed new feature or change:"
   validations:
-    required: true
+    required: true

.github/ISSUE_TEMPLATE/maintenance.md

@@ -0,0 +1,18 @@
+---
+name: Maintenance
+about: "Maintainers only: Issues for maintenance tasks"
+title: "MNT: <Write a comprehensive title after the 'MNT: ' prefix>"
+labels: "maintenance"
+assignees: ""
+---
+
+**Description of the maintenance task**
+
+<!--
+Please, explain in detail the issue that requires action to be taken, or why we
+should implement certain feature to easy and improve the maintenance of the
+package.
+
+If the task can be split in different PRs, list suggested action items to start
+working on it.
+-->

.github/ISSUE_TEMPLATE/post-install.yml

@@ -1,5 +1,5 @@
 name: Post-install/importing issue
-description: Report an issue if you have trouble importing SimPEG after installation.
+description: Report an issue if you have trouble importing `simpeg` after installation.
 title: "<Please write a comprehensive title here>"
 labels: [Installation]