Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 8 additions & 14 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
@@ -1,28 +1,22 @@
# .readthedocs.yaml
# Read the Docs configuration file
# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details

# Required
version: 2
sphinx:
# Path to your Sphinx configuration file.
configuration: docs/conf.py

# Set the version of Python and other tools you might need
# https://docs.readthedocs.io/en/stable/config-file/v2.html
build:
os: ubuntu-22.04
os: ubuntu-24.04
tools:
python: "3.11"

# Generate the Sphinx configuration for Jupyter Book so it builds
jobs:
pre_build:
- "jupyter-book config sphinx docs/"

# Set the build to use dependencies in pyproject.toml
python:
install:
- method: pip
path: .
extra_requirements:
- develop
- develop

sphinx:
configuration: docs/conf.py
builder: html
fail_on_warning: false
18 changes: 8 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,6 @@ As part of NREL's [Hybrid Energy Systems Research](https://www.nrel.gov/wind/hyb
software assesses optimal designs for the deployment of distributed, commercial, and utility-scale hybrid energy plants, particularly considering wind,
solar and storage.


## Part of the WETO Stack

HOPP is primarily developed with the support of the U.S. Department of Energy and is part of the [WETO Software Stack](https://nrel.github.io/WETOStack). For more information and other integrated modeling software, see:
- [Portfolio Overview](https://nrel.github.io/WETOStack/portfolio_analysis/overview.html)
- [Entry Guide](https://nrel.github.io/WETOStack/_static/entry_guide/index.html)
- [Techno-Economic Modeling Workshop](https://nrel.github.io/WETOStack/workshops/user_workshops_2024.html#tea-and-cost-modeling)
- [Systems Engineering Workshop](https://nrel.github.io/WETOStack/workshops/user_workshops_2024.html#systems-engineering)


## Software requirements

- Python version 3.11 or higher
Expand Down Expand Up @@ -108,3 +98,11 @@ The [Examples](./examples/) contain Jupyter notebooks and sample YAML files for

Interested in improving HOPP? Please see the [Contributor's Guide](docs/CONTRIBUTING.md)
for more information.

## Part of the WETO Stack

HOPP is primarily developed with the support of the U.S. Department of Energy and is part of the [WETO Software Stack](https://nrel.github.io/WETOStack). For more information and other integrated modeling software, see:
- [Portfolio Overview](https://nrel.github.io/WETOStack/portfolio_analysis/overview.html)
- [Entry Guide](https://nrel.github.io/WETOStack/_static/entry_guide/index.html)
- [Techno-Economic Modeling Workshop](https://nrel.github.io/WETOStack/workshops/user_workshops_2024.html#tea-and-cost-modeling)
- [Systems Engineering Workshop](https://nrel.github.io/WETOStack/workshops/user_workshops_2024.html#systems-engineering)
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ develop = [
"pytest-subtests",
"pytest-dependency",
"responses",
"jupyter-book",
"jupyter-book<2",
"sphinxcontrib-napoleon",
]
examples = ["jupyterlab"]
Expand Down
Loading