Skip to content

Commit

Permalink
removes pyomo from setup.py and adds guidance to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
samgdotson committed Feb 29, 2024
1 parent 4f91686 commit d4b7102
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 1 deletion.
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,17 @@ cd osier
pip install .
# to also install the documentation dependencies
pip install .[doc]

# followed by
pip install pyomo==4.6.1
```

[!NOTE]
Although `pyomo` is a dependency, the current version of `pyomo` (6.7.1, as of 2/29/24) has a bug
that prints erroneous errors during an `osier` simulation. Therefore, users are recommended to
install a specific version of `pyomo` after the main installation of `osier`. There is an open issue #50
related to this concern.

## Documentation
The documentation for `osier` can be viewed [here](https://osier.readthedocs.io/en/latest/).
You can also build the docs locally with:
Expand Down
1 change: 0 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,6 @@
'nrelpy',
'unyt',
'pyomo',
'pymoo',
'pyentrp',
'deap',]
EXTRAS_REQUIRE = {
Expand Down

0 comments on commit d4b7102

Please sign in to comment.