Updates to Readme and Docs (#267)

* updated readme to include a table of analysis methods and placeholder citations, updated citation instructions, and a warning box showing a disclaimer related to use

* update line length and new lines

* readme.md

* updating readme references

* warning in yaw misalignment description in readme

* more references added to readme

* binder framing in overview

* update background paragraph

* update badges

* update title levels

* Added some text about goals of the project to first paragraph. Added JOSS citation to references list.

* Added tech report and openoa citations to intro. Moved citation definitions to end of readme.

* fix typos and line lengths

* add all contributors config file

* add readme config

* update readme convention

* update all-contributors and fix what I broke

* update readme

* fix references to lowercase readme

* update all-contributors

* increase navbar level to 3

* fix logged method function/method signatures

* fix readme headers

* fix all-contributors and add missing people

* update contributions specs

* update documentation homepage

* Update .all-contributorsrc

* update README all-contributors table

* shift installation section towards middle of docs homepage

* turn off test runners for non-code changes in PRs

* reattempt workflow update

* last try

* attempt pr section

---------

Co-authored-by: RHammond2 <[email protected]>
Co-authored-by: Eric Simley <[email protected]>
Co-authored-by: ejsimley <[email protected]>

.all-contributorsrc

@@ -0,0 +1,187 @@
+{
+  "projectName": "OpenOA",
+  "projectOwner": "NREL",
+  "repoType": "github",
+  "repoHost": "https://github.com",
+  "files": [
+    "README.md"
+  ],
+  "imageSize": 100,
+  "commit": false,
+  "commitConvention": "angular",
+  "contributorsPerLine": 7,
+  "linkToUsage": true,
+  "contributors": [
+    {
+      "login": "RHammond2",
+      "name": "Rob Hammond",
+      "avatar_url": "https://avatars.githubusercontent.com/u/13874373?v=4",
+      "profile": "https://www.linkedin.com/in/rob-hammond-33583756/",
+      "contributions": [
+        "code",
+        "doc",
+        "review",
+        "tutorial",
+        "maintenance",
+        "ideas",
+        "fundingFinding"
+      ]
+    },
+    {
+      "login": "jordanperr",
+      "name": "Jordan Perr-Sauer",
+      "avatar_url": "https://avatars.githubusercontent.com/u/355615?v=4",
+      "profile": "https://github.com/jordanperr",
+      "contributions": [
+        "doc",
+        "code",
+        "review",
+        "tutorial",
+        "maintenance",
+        "ideas",
+        "fundingFinding"
+      ]
+    },
+    {
+      "login": "ejsimley",
+      "name": "ejsimley",
+      "avatar_url": "https://avatars.githubusercontent.com/u/40040961?v=4",
+      "profile": "https://github.com/ejsimley",
+      "contributions": [
+        "projectManagement",
+        "code",
+        "data",
+        "doc",
+        "review",
+        "tutorial",
+        "ideas",
+        "fundingFinding"
+      ]
+    },
+    {
+      "login": "Dynorat",
+      "name": "Jason Fields",
+      "avatar_url": "https://avatars.githubusercontent.com/u/4141650?v=4",
+      "profile": "https://github.com/Dynorat",
+      "contributions": [
+        "projectManagement",
+        "review",
+        "business",
+        "design",
+        "fundingFinding"
+      ]
+    },
+    {
+      "login": "nbodini",
+      "name": "Nicola Bodini",
+      "avatar_url": "https://avatars.githubusercontent.com/u/55894604?v=4",
+      "profile": "https://github.com/nbodini",
+      "contributions": [
+        "code",
+        "review",
+        "tutorial",
+        "ideas"
+      ]
+    },
+    {
+      "login": "moptis",
+      "name": "moptis",
+      "avatar_url": "https://avatars.githubusercontent.com/u/32751681?v=4",
+      "profile": "https://github.com/moptis",
+      "contributions": [
+        "code",
+        "data",
+        "doc",
+        "review",
+        "tutorial",
+        "ideas"
+      ]
+    },
+    {
+      "login": "joejoeyjoseph",
+      "name": "Joseph Lee",
+      "avatar_url": "https://avatars.githubusercontent.com/u/22756182?v=4",
+      "profile": "https://github.com/joejoeyjoseph",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "charlie9578",
+      "name": "Charlie",
+      "avatar_url": "https://avatars.githubusercontent.com/u/14888896?v=4",
+      "profile": "https://charlie9578.github.io/",
+      "contributions": [
+        "code",
+        "data",
+        "doc",
+        "tutorial",
+        "ideas"
+      ]
+    },
+    {
+      "login": "zheitkamp1",
+      "name": "zheitkamp1",
+      "avatar_url": "https://avatars.githubusercontent.com/u/53791791?v=4",
+      "profile": "https://github.com/zheitkamp1",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "abbey2017",
+      "name": "Abiodun Timothy Olaoye",
+      "avatar_url": "https://avatars.githubusercontent.com/u/26353690?v=4",
+      "profile": "https://github.com/abbey2017",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "kthyng",
+      "name": "Kristen Thyng",
+      "avatar_url": "https://avatars.githubusercontent.com/u/3487237?v=4",
+      "profile": "http://kristenthyng.com/",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "rafmudaf",
+      "name": "Rafael M Mudafort",
+      "avatar_url": "https://avatars.githubusercontent.com/u/13797903?v=4",
+      "profile": "http://www.rafmudaf.com/",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "sebastianpfaffel",
+      "name": "sebastianpfaffel",
+      "avatar_url": "https://avatars.githubusercontent.com/u/22168894?v=4",
+      "profile": "https://github.com/sebastianpfaffel",
+      "contributions": [
+        "code"
+      ]
+    },
+    {
+      "login": "nateagarwal",
+      "name": "nateagarwal",
+      "avatar_url": "https://avatars.githubusercontent.com/u/51377789?v=4",
+      "profile": "https://github.com/nateagarwal",
+      "contributions": [
+        "code",
+        "review"
+      ]
+    },
+    {
+      "login": "Var-Char",
+      "name": "Var-Char",
+      "avatar_url": "https://avatars.githubusercontent.com/u/16821332?v=4",
+      "profile": "https://github.com/Var-Char",
+      "contributions": [
+        "code"
+      ]
+    }
+  ]
+}

.github/workflows/ci-tests.yml

@@ -2,9 +2,14 @@ name: Run Unit and Regression Tests with Code Coverage
 
 on:
   push:
-    branches: [ main, develop, develop_v3 ]
-  pull_request:
-    branches: [ main, develop, develop_v3 ]
+    branches: [main, develop]
+    pull_request:
+      branches: [main, develop]
+      paths-ignore:  # No need to rerun all the tests if we're only editing documentation and examples
+        - "examples/**.ipynb"
+        - "sphinx/**"
+        - "**.md"
+        - "**.rst"
   schedule:
     - cron: "0 0 * * MON"
 

MANIFEST.in

@@ -1,3 +1,3 @@
 include LICENSE.txt
 
-include readme.md
+include README.md