This release has been yanked by its maintainers, and will be ignored by installers, except when explicitly specified.
Consider using release 0.2.3 instead.
Reason given by maintainers: Math functions and comparisons return wrong results under the "auto" derivative method, silently in several cases. Fixed in 0.2.2; use 0.2.2 or later.
YAPSS: Yet Another Pseudo-Spectral Solver
YAPSS is a Python library for formulating and solving optimal-control problems with pseudospectral methods.
YAPSS provides:
- Legendre-Gauss, Legendre-Gauss-Radau, and Legendre-Gauss-Lobatto collocation methods, using a computational approach based on the GPOPS-II algorithm of Patterson and Rao (2014)
- Multiple differentiation approaches: automatic differentiation via CasADi, user-supplied derivatives, and central-difference numerical differentiation for problems not amenable to automatic differentiation
- Multi-phase problems and segmented meshes
- An interface designed to identify common formulation errors early
- Worked examples as both Python scripts and Jupyter notebooks
Start here
- Install YAPSS.
- Work through the tutorial to define and solve a first problem.
- Browse the examples for complete applications.
Installation
YAPSS requires Python 3.10 or later. Install it into a virtual environment with pip:
$ python -m venv yapss-env
$ source yapss-env/bin/activate
(yapss-env) $ python -m pip install --upgrade pip
(yapss-env) $ python -m pip install yapss
Alternatively, install it with Conda:
$ conda create -n yapss-env python=3.10
$ conda activate yapss-env
(yapss-env) $ conda install -c conda-forge yapss
Verify the Installation
Run the HS071 example, a small constrained optimization problem:
(yapss-env) $ python -m yapss.examples.hs071
YAPSS is installed correctly if the run finishes, and the output ends with
Objective value
f(x*) = 1.701402e+01
YAPSS solution is correct.
The value of the final digits of the objective may vary between platforms and solver versions.
Where to go next
- New to YAPSS? Start with the tutorial.
- Looking for a pattern to adapt? Browse the notebook examples or script examples.
- Need API details? See the reference documentation in the navigation sidebar.
- Want to contribute? Contributions are welcome! Read Contributing to YAPSS.
License
YAPSS is licensed under the MIT License. See the License page for more information.
Documentation
The documentation is available on Read the Docs.
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file yapss-0.2.1.tar.gz.
File metadata
- Download URL: yapss-0.2.1.tar.gz
- Upload date:
- Size: 231.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c5c39d488ef2084aa0c4be6315e93c37ae206cf64bad53d99fb76406aa48a906
|
|
| MD5 |
0aa494d459a19647c987879245f086c4
|
|
| BLAKE2b-256 |
bbd022bd2aab7f84289f24594af19f0388b04344b897ecdada4a0c1dc4eb608c
|
Provenance
The following attestation bundles were made for yapss-0.2.1.tar.gz:
Publisher:
publish.yml on stevenrhall/yapss
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
yapss-0.2.1.tar.gz -
Subject digest:
c5c39d488ef2084aa0c4be6315e93c37ae206cf64bad53d99fb76406aa48a906 - Sigstore transparency entry: 2498716919
- Sigstore integration time:
-
Permalink:
stevenrhall/yapss@f9e350602878b2318b9f0933c472ee50996778e6 -
Branch / Tag:
refs/tags/v0.2.1 - Owner: https://github.com/stevenrhall
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@f9e350602878b2318b9f0933c472ee50996778e6 -
Trigger Event:
push
-
Statement type:
File details
Details for the file yapss-0.2.1-py3-none-any.whl.
File metadata
- Download URL: yapss-0.2.1-py3-none-any.whl
- Upload date:
- Size: 133.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7340fe5bee96b23d5137834aa2ff68abb25f6ace7e4e017c543ceffcefc317ec
|
|
| MD5 |
12ec375f4c445e044b519d45c5c37f89
|
|
| BLAKE2b-256 |
dbb515b7cbc96d0ec3fd87d76a73f703eda1994241680825507a021599946d56
|
Provenance
The following attestation bundles were made for yapss-0.2.1-py3-none-any.whl:
Publisher:
publish.yml on stevenrhall/yapss
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
yapss-0.2.1-py3-none-any.whl -
Subject digest:
7340fe5bee96b23d5137834aa2ff68abb25f6ace7e4e017c543ceffcefc317ec - Sigstore transparency entry: 2498717020
- Sigstore integration time:
-
Permalink:
stevenrhall/yapss@f9e350602878b2318b9f0933c472ee50996778e6 -
Branch / Tag:
refs/tags/v0.2.1 - Owner: https://github.com/stevenrhall
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@f9e350602878b2318b9f0933c472ee50996778e6 -
Trigger Event:
push
-
Statement type: