Develop -> Main (v0.1.1)

.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+name: Testing
+
+on: [ push, pull_request ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .[all]
+      - name: Create env file
+        run: |
+          touch .env
+      - name: Run tests
+        run: |
+          pytest .

.github/workflows/ci_docs.yml

@@ -0,0 +1,20 @@
+name: Test Documentation Build
+
+on: [ push, pull_request ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.11
+      - name: Install dependencies
+        run: |
+          pip install ".[develop]"
+      - name: Build documentation
+        run: |
+          jupyter-book build docs/

.pre-commit-config.yaml

@@ -1,21 +1,24 @@
+default_language_version:
+    python: python3
+
 repos:
--   repo: https://github.com/timothycrosley/isort
-    rev: 5.10.1
+-   repo: https://github.com/pycqa/isort
+    rev: 5.12.0
     hooks:
         - id: isort
           name: isort
-          stages: [commit]
+          stages: [pre-commit]
 
 -   repo: https://github.com/psf/black
     rev: 22.3.0
     hooks:
         - id: black
           name: black
-          stages: [commit]
+          stages: [pre-commit]
           language_version: python3
 
 -   repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.3.0
+    rev: v4.5.0
     hooks:
     -   id: trailing-whitespace
     -   id: end-of-file-fixer

CITATION.cff

@@ -0,0 +1,14 @@
+cff-version: 0.0.0
+message: "If you use this software, please cite it as below."
+authors:
+- family-names: "Mona"
+  given-names: "Lisa"
+  orcid: "https://orcid.org/0000-0000-0000-0000"
+- family-names: "Bot"
+  given-names: "Hew"
+  orcid: "https://orcid.org/0000-0000-0000-0000"
+title: "My Research Software"
+version: 2.0.4
+doi: 10.5281/zenodo.1234
+date-released: 2017-12-18
+url: "https://github.com/github-linguist/linguist"

docs/CONTRIBUTING.md

@@ -0,0 +1,56 @@
+# Contributing
+
+We welcome contributions in the form of bug reports, bug fixes, improvements to the documentation,
+ideas for enhancements (or the enhancements themselves!).
+
+You can find a [list of current issues](https://github.com/NREL/electrolyzer/issues) in the project's
+GitHub repo. Feel free to tackle any existing bugs or enhancement ideas by submitting a
+[pull request](https://github.com/NREL/electrolyzer/pulls).
+
+## Bug Reports
+
+* Please include a short (but detailed) Python snippet or explanation for reproducing the problem.
+  Attach or include a link to any input files that will be needed to reproduce the error.
+* Explain the behavior you expected, and how what you got differed.
+
+## Pull Requests
+
+* Please reference relevant GitHub issues in your commit message using `GH123` or `#123`.
+* Changes should be [PEP8](http://www.python.org/dev/peps/pep-0008/) compatible.
+* Keep style fixes to a separate commit to make your pull request more readable.
+* Docstrings are required and should follow the
+  [Google style](https://www.sphinx-doc.org/en/master/usage/extensions/example_google.html).
+* When you start working on a pull request, start by creating a new branch pointing at the latest
+  commit on [main](https://github.com/NREL/electrolyzer).
+* The electrolyzer copyright policy is detailed in the [`LICENSE`](https://github.com/NREL/electrolyzer/blob/main/LICENSE).
+
+## Documentation
+
+When contributing new features, or fixing existing capabilities, be sure to add and/or update the
+docstrings as needed to ensure the documentation site stays up to date with the latest changes.
+
+To build the documentation locally, the following command can be run in your terminal in the docs
+directory of the repository:
+
+```bash
+sh build_book.sh
+```
+
+In addition to generating the documentation, be sure to check the results by opening the following
+path in your browser: `file://<path-to-electrolyzer>/electrolyzer/docs/_build/html/index.html`.
+
+```{note}
+If the browser appears to be out of date from what you expected to built, please try the following, roughly in order:
+1. Reload the page a few times
+2. Clear your browser's cache and open the page again.
+3. Delete the `_build` folder and rebuild the docs
+```
+
+## Tests
+
+The test suite can be run using `pytest .`
+
+When you push to your fork, or open a PR, your tests will be run against the
+[Continuous Integration (CI)](https://github.com/NREL/electrolyzer/actions) suite. This will start a build
+that runs all tests on your branch against multiple Python versions, and will also test
+documentation builds.

docs/_config.yml

@@ -0,0 +1,67 @@
+# Book settings
+# Learn more at https://jupyterbook.org/customize/config.html
+
+title: Electrolyzer
+author: National Renewable Energy Laboratory
+# logo: logo.png
+copyright: "2025"
+only_build_toc_files: false
+# exclude_patterns: [_build, Thumbs.db, .DS_Store, "**.ipynb_checkpoints", .github]
+
+# Force re-execution of notebooks on each build.
+# See https://jupyterbook.org/content/execute.html
+execute:
+  execute:
+  execute_notebooks: auto
+  timeout: -1  # better for longer running notebooks
+  merge_streams: true  # keeps unsynchronized cell outputs in a single output cell
+  exclude_patterns:
+    - _build
+    - Thumbs.db
+    - DS_Store
+    - "**.ipynb_checkpoints"
+
+# Define the name of the latex output file for PDF builds
+latex:
+  latex_documents:
+    targetname: book.tex
+
+# Information about where the book exists on the web
+repository:
+  url: https://github.com/NREL/electrolyzer
+  path_to_book: docs
+  branch: main
+
+# Add GitHub buttons to your book
+# See https://jupyterbook.org/customize/config.html#add-a-link-to-your-repository
+html:
+  use_issues_button: true
+  use_repository_button: true
+  baseurl: https://nrel.github.io/electrolyzer/
+
+sphinx:
+  extra_extensions:
+  - "sphinx.ext.autodoc"
+  - "sphinx.ext.autosummary"
+  - "sphinx.ext.napoleon"
+
+  config:
+    language: 'python'
+    autosummary_generate: true
+    autodoc_default_options:
+      members: true
+      member-order: bysource
+      undoc-members: true
+      private-members: true
+      # special-members: true
+      # inherited-members
+      # show-inheritance
+      # ignore-module-all
+      # imported-members: true
+      # exclude-members
+      # class-doc-from
+      # no-value
+    autodoc_typehints: description
+    napoleon_use_admonition_for_notes: true
+    napoleon_use_rtype: false
+    nb_merge_streams: true

docs/_toc.yml

@@ -0,0 +1,10 @@
+# Table of contents
+# Learn more at https://jupyterbook.org/customize/toc.html
+
+format: jb-book
+root: intro
+parts:
+- caption: Getting Started
+  chapters:
+    - file: installing
+    - file: CONTRIBUTING