Skip to main content

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

  1. Install YAPSS.
  2. Work through the tutorial to define and solve a first problem.
  3. 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

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

yapss-0.2.2.tar.gz (367.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

yapss-0.2.2-py3-none-any.whl (146.5 kB view details)

Uploaded Python 3

File details

Details for the file yapss-0.2.2.tar.gz.

File metadata

  • Download URL: yapss-0.2.2.tar.gz
  • Upload date:
  • Size: 367.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for yapss-0.2.2.tar.gz
Algorithm Hash digest
SHA256 d8bc6b617b8b728afac5cbe0da40eda91347ba0904b8216a213259c39c93dcba
MD5 4c64b84578c0f09d866fba84320b5372
BLAKE2b-256 e4b283f34fae2080a2477c18289cd6490b101b603cbafb3bd8be69ec25758c28

See more details on using hashes here.

Provenance

The following attestation bundles were made for yapss-0.2.2.tar.gz:

Publisher: publish.yml on stevenrhall/yapss

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file yapss-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: yapss-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 146.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for yapss-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 ec171be3464a9591cb43feb5cf23d266ee7f3e02fcb3fd8afc7ac6159d97adc4
MD5 c13bf8ac215664404f020cabd96dc3c5
BLAKE2b-256 ec90afc6df34a42333e11638ae6f1fea62b5f74e63d0f733ac05b8b250c87113

See more details on using hashes here.

Provenance

The following attestation bundles were made for yapss-0.2.2-py3-none-any.whl:

Publisher: publish.yml on stevenrhall/yapss

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

0.2.3

2 files

This release

0.2.2 This release

2 files

0.2.1

2 files

0.2.1rc1

2 files

0.2.0

2 files

0.1.1

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page