Metadata-Version: 2.1
Name: ropt
Version: 0.1.1
Summary: The ropt ensemble optimizer module
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy
Requires-Dist: pydantic
Requires-Dist: scipy
Requires-Dist: importlib-metadata ; python_version < "3.10"
Requires-Dist: typing-extensions ; python_version < "3.9"
Provides-Extra: docs
Requires-Dist: mkdocs ; extra == 'docs'
Requires-Dist: mkdocstrings[python] ; extra == 'docs'
Requires-Dist: mkdocs-material ; extra == 'docs'
Provides-Extra: parsl
Requires-Dist: parsl ; extra == 'parsl'
Provides-Extra: storage
Requires-Dist: pandas ; extra == 'storage'
Requires-Dist: xarray ; extra == 'storage'
Requires-Dist: netcdf4 ; extra == 'storage'
Requires-Dist: tabulate ; extra == 'storage'
Provides-Extra: test
Requires-Dist: ruff ; extra == 'test'
Requires-Dist: mypy ; extra == 'test'
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pandas-stubs ; extra == 'test'
Requires-Dist: types-tabulate ; extra == 'test'

# `ropt`
`ropt` is a Python module for running robust optimization workflows.

`ropt` is developed by the Netherlands Organisation for Applied Scientific
Research (TNO). All files in this repository are released under the GNU General
Public License v3.0 (a copy is provided in the LICENSE file).

## Dependencies
`ropt` has been tested with Python versions 3.8-3.12.

`ropt` requires one or more optimization backends to function. A backend based
on optimizers included in [SciPy](https://scipy.org/) is installed by default.

## Installation
```bash
pip install ropt
```

To enable some options, the following optional-dependencies can be installed:

- `storage` : Enables `pandas`, `xarrays` and netCDF support.
- `parsl`   : Enables the parsl-based evaluator functionality.

To install both:
```bash
pip install ropt[storage,parsl]
```

## Documentation
Detailed documentation and examples can be found in the online manual (on
[GitHubPages](https://tno-ropt.github.io/ropt/) or on [Read the
Docs](https://ropt.readthedocs.io/)).
