Metadata-Version: 2.1
Name: philote-mdo
Version: 0.5.3
Summary: Python bindings that implement the Philote-MDO standard.
Home-page: https://chrislupp.github.io/Philote-Python/
License: Apache-2.0
Keywords: mdo,optimization,rpc
Author: Christopher Lupp
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: grpcio (>=1.49.1,<2.0.0)
Requires-Dist: numpy (>=1.19.0,<2.0.0)
Requires-Dist: scipy (>=1.12.0,<2.0.0)
Project-URL: Documentation, https://chrislupp.github.io/Philote-Python/
Project-URL: Repository, https://github.com/chrislupp/Philote-Python
Description-Content-Type: text/markdown

![Philote](https://github.com/chrislupp/Philote-Python/blob/main/doc/graphics/philote-python.svg?raw=true)

[![Unit and Regression Tests](https://github.com/chrislupp/Philote-Python/actions/workflows/tests.yaml/badge.svg)](https://github.com/chrislupp/Philote-Python/actions/workflows/tests.yaml)
[![Coverage Status](https://coveralls.io/repos/github/chrislupp/Philote-Python/badge.svg?branch=main)](https://coveralls.io/github/chrislupp/Philote-Python?branch=main)
[![Deploy Documentation](https://github.com/chrislupp/Philote-Python/actions/workflows/documentation.yaml/badge.svg)](https://github.com/chrislupp/Philote-Python/actions/workflows/documentation.yaml)
# Philote-Python

Python library for using and creating Philote analysis servers.

Documentation can be found at:

https://chrislupp.github.io/Philote-Python


## Requirements

The installation/build process requires the following tools to be installed
(they will be installed if not present):

- grpcio-tools
- protoletariat
- importlib.resources

Additionally, the following dependencies are required by Philote MDO and will be
installed automatically during the installation process:

- numpy
- scipy
- grpcio


## Installation

Older versions of this library featured a two-step build process. This has since
been simplified. To install the package run pip:

    pip install <path/to/Philote-Python>

or

    pip install -e <path/to/Philote-Python>

for an editable install. Note, that <path/to/Philote-Python> is the path to the
repository root directory (the one containing pyproject.toml). Often, people
install packages when located in that directory, making the corresponding
command:

    pip install .


### Potential Issues

Some users have reported that grpcio-tools does not install the protoc
executable required to generate the stubs. If you run into this issue, you
will have to manually install the protoc executable (make sure to match the
version of gRPC that you have installed) and make it discoverable on your PATH.


## License

This package is licensed under the Apache 2 license:


>   Copyright 2022-2024 Christopher A. Lupp
>   
>   Licensed under the Apache License, Version 2.0 (the "License");
>   you may not use this file except in compliance with the License.
>   You may obtain a copy of the License at
>   
>       http://www.apache.org/licenses/LICENSE-2.0
>   
>   Unless required by applicable law or agreed to in writing, software
>   distributed under the License is distributed on an "AS IS" BASIS,
>   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
>   See the License for the specific language governing permissions and
>   limitations under the License.



This work has been cleared for public release, distribution unlimited, case
number: AFRL-2023-5713.

The views expressed are those of the authors and do not reflect the official
guidance or position of the United States Government, the Department of Defense
or of the United States Air Force.

Statement from DoD: The Appearance of external hyperlinks does not constitute
endorsement by the United States Department of Defense (DoD) of the linked
websites, of the information, products, or services contained therein. The DoD
does not exercise any editorial, security, or other control over the information
you may find at these locations.

