Merge pull request #17 from NREL/dev

Many updates in prep for a tagged release

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,30 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+## Description
+_Describe the bug here_
+
+### Steps to reproduce issue
+_Please provide a minimum working example (MWE) if possible_
+
+1. …
+2. …
+3. …
+
+### Current behavior
+…
+
+### Expected behavior
+…
+
+
+### Code versions
+_List versions only if relevant_
+- Python
+- …

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,14 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+# Description of feature
+Describe the feature here and provide some context. Under what scenario would this be useful?
+
+# Potential solution
+Can you think of ways to implement this?

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,28 @@
+Delete the text explanations below these headers and replace them with information about your PR.
+Please first consult the [developer guide](https://weis.readthedocs.io/en/latest/how_to_contribute_code.html) to make sure your PR follows all code, testing, and documentation conventions.
+
+## Purpose
+Explain the goal of this pull request. If it addresses an existing issue be sure to link to it. Describe the big picture of your changes here, perhaps using a bullet list if multiple changes are done to accomplish a single goal. If it accomplishes multiple goals, it may be best to create separate PR's for each. 
+
+## Type of change
+What types of change is it?
+_Select the appropriate type(s) that describe this PR_
+
+- [ ] Bugfix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (non-backwards-compatible fix or feature)
+- [ ] Code style update (formatting, renaming)
+- [ ] Refactoring (no functional changes, no API changes)
+- [ ] Documentation update
+- [ ] Maintenance update
+- [ ] Other (please describe)
+
+## Testing
+Explain the steps needed to test the new code to verify that it does indeed address the issue and produce the expected behavior.
+
+## Checklist
+_Put an `x` in the boxes that apply._
+
+- [ ] I have run existing tests which pass locally with my changes
+- [ ] I have added new tests or examples that prove my fix is effective or that my feature works
+- [ ] I have added necessary documentation

.github/workflows/CI_MoorPy.yml

@@ -0,0 +1,79 @@
+name: CI_MoorPy
+
+# We run CI on push commits and pull requests on all branches
+on: [push, pull_request]
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+    build_pip:
+        name: Pip Build (${{ matrix.os }}) - ${{ matrix.python-version }}
+        runs-on: ${{ matrix.os }}
+        defaults:
+            run:
+                shell: bash -l {0}
+
+        strategy:
+            fail-fast: false #true
+            matrix:
+                os: ["ubuntu-latest", "macOS-latest", "windows-latest"]
+                python-version: ["3.9", "3.10", "3.11"]
+
+        steps:
+            - name: checkout repository
+              uses: actions/checkout@v3
+
+            - name: Set up Python ${{ matrix.python-version }}
+              uses: actions/setup-python@v4
+              id: cp
+              with:
+                  python-version: ${{ matrix.python-version }}
+                  update-environment: true
+
+            - name: Pip Install MoorPy
+              run: |
+                  '${{ steps.cp.outputs.python-path }}' -m pip install -vv -e .[test]
+
+            - name: Test run
+              run: |
+                  cd tests
+                  '${{ steps.cp.outputs.python-path }}' -m pytest .
+
+
+    build_conda:
+        name: Conda Build (${{ matrix.os }}) - ${{ matrix.python-version }}
+        runs-on: ${{ matrix.os }}
+        defaults:
+            run:
+                shell: bash -l {0}
+
+        strategy:
+            fail-fast: false
+            matrix:
+                os: ["ubuntu-latest", "macOS-latest", "windows-latest"]
+                python-version: ["3.9", "3.10", "3.11"]
+
+        steps:
+            - name: checkout repository
+              uses: actions/checkout@v3
+
+            - uses: conda-incubator/setup-miniconda@v2
+              # https://github.com/marketplace/actions/setup-miniconda
+              with:
+                  miniconda-version: "latest"
+                  auto-update-conda: true
+                  python-version: ${{ matrix.python-version }}
+                  environment-file: environment.yml
+                  channels: conda-forge
+                  activate-environment: test
+                  auto-activate-base: false
+
+            # Install 
+            - name: Conda Install MoorPy
+              run: |
+                  python -m pip install -e . -vv
+
+            - name: Test run
+              run: |
+                  cd tests
+                  pytest .
+

.github/workflows/Publish_MoorPy.yml

@@ -0,0 +1,48 @@
+name: Build and upload to PyPI
+
+# Build on every branch push, tag push, and pull request change:
+#on: [push, pull_request]
+# Alternatively, to publish when a (published) GitHub Release is created, use the following:
+on:
+    push:
+    pull_request:
+    release:
+        types:
+            - published
+
+jobs:
+    build_and_upload_pypi:
+        runs-on: ubuntu-latest
+        strategy:
+            fail-fast: false
+            matrix:
+                python-version: ["3.9", "3.10", "3.11"]
+
+        # upload to PyPI on every tag starting with 'v'
+        #if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
+        # alternatively, to publish when a GitHub Release is created, use the following rule:
+        if: github.event_name == 'release' && github.event.action == 'published'
+        steps:
+            - name: checkout repository
+              uses: actions/checkout@v3
+
+            - name: Set up Python ${{ matrix.python-version }}
+              uses: actions/setup-python@v4
+              id: cp
+              with:
+                  python-version: ${{ matrix.python-version }}
+                  update-environment: true
+
+            - name: Install pypa/build
+              run: |
+                  python -m pip install build
+
+            - name: Build a binary wheel and a source tarball
+              run: |
+                  python -m build .
+
+            - uses: pypa/[email protected]
+              with:
+                  user: __token__
+                  password: ${{ secrets.pypi_password }}
+                  # To test: repository_url: https://test.pypi.org/legacy/

.gitignore

@@ -1,6 +1,167 @@
-
-*.pyc
-__pycache__
+# MoorPy specifics
 MoorPy.egg-info
+docs/build
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
 
-docs/build
+# Emacs
+*~