Skip to content

Commit

Permalink
Update minimum required version of dependencies (#451)
Browse files Browse the repository at this point in the history
* Update setup.py

* Update README.md

* Update README.md

* Update setup.py

* Update installation.rst

* Update README.md

* Update setup.py

* Update .readthedocs.yaml

* Bump patch version

* Update setup.py

* Update README.md

---------

Co-authored-by: Alasdair Gray <[email protected]>
  • Loading branch information
kanekosh and A-CGray authored Feb 20, 2025
1 parent b5ac877 commit c8ee686
Show file tree
Hide file tree
Showing 5 changed files with 19 additions and 34 deletions.
3 changes: 3 additions & 0 deletions .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ build:
tools:
python: "3.11"

sphinx:
configuration: openaerostruct/docs/conf.py

python:
install:
- method: pip
Expand Down
19 changes: 1 addition & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -89,26 +89,9 @@ John P. Jasa, Shamsheer S. Chauhan, Justin S. Gray, and Joaquim R. R. A. Martins
Year = {2019}}
```

Version Information
-------------------
The oldest and latest versions of the dependencies that we test regularly are the following (other versions may work, but no guarantees):

| Dependency | oldest | latest |
|--------------------|--------| ------ |
| Python | 3.8 | 3.11 |
| NumPy | 1.20 | latest |
| SciPy | 1.6.0 | latest |
| OpenMDAO | 3.35 | latest |
| Matplotlib | latest | latest |
| MPhys (optional) | 2.0.0 | latest |
| pyGeo (optional) | 1.6.0 | latest |
| OpenVSP (optional) | 3.27.1 | 3.27.1 |

If you are looking to use the previous version of OpenAeroStruct which uses OpenMDAO 1.7.4, use OpenAeroStruct 1.0 from [here](https://github.com/mdolab/OpenAeroStruct/releases).

License
-------
Copyright 2018-2023 MDO Lab
Copyright 2018 MDO Lab

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down
2 changes: 1 addition & 1 deletion openaerostruct/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "2.10.0"
__version__ = "2.10.1"
23 changes: 11 additions & 12 deletions openaerostruct/docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,31 +35,30 @@ The oldest and latest versions of the dependencies that we test regularly are th
- oldest
- latest
* - Python
- 3.8
- 3.9
- 3.11
* - NumPy
- 1.20
- latest
- 1.21
- 1.26
* - SciPy
- 1.6.0
- latest
- 1.7
- 1.15
* - OpenMDAO
- 3.35
- latest
* - Matplotlib
- latest
- latest
* - pyGeo (optional)
- 1.6.0
- 1.15.0
- latest
* - OpenVSP (optional)
- 3.27.1
- 3.27.1
- 3.33
- 3.33
* - MPhys (optional)
- 2.0
- latest

If you are unfamiliar with OpenMDAO and wish to modify the internals of OpenAeroStruct, you should examine the OpenMDAO documentation at http://openmdao.org/twodocs/versions/latest/index.html. The tutorials provided with OpenMDAO are helpful to understand the basics of using OpenMDAO to solve an optimization problem.
Numpy 2.0 or later should also work, but we currently do not run tests with Numpy 2.

If you are unfamiliar with OpenMDAO and wish to modify the internals of OpenAeroStruct, you should examine the OpenMDAO documentation at https://openmdao.org/newdocs/versions/latest/main.html. The tutorials provided with OpenMDAO are helpful to understand the basics of using OpenMDAO to solve an optimization problem.

Advanced Options
~~~~~~~~~~~~~~~~
Expand Down
6 changes: 3 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -52,10 +52,10 @@
# Test files
package_data={"openaerostruct": ["tests/*.py", "*/tests/*.py", "*/*/tests/*.py"]},
install_requires=[
# Remember to update the oldest versions in the GitHub Actions build, the readme, and in docs/installation.rst
# Remember to update the oldest versions in docs/installation.rst
"openmdao>=3.35",
"numpy>=1.20",
"scipy>=1.6.0",
"numpy>=1.21",
"scipy>=1.7",
"matplotlib",
],
extras_require=optional_dependencies,
Expand Down

0 comments on commit c8ee686

Please sign in to comment.