Skip to content

Commit

Permalink
Clarify mathematical notation and improve wording in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aarontrowbridge committed Feb 19, 2025
1 parent b9e6368 commit fa768cc
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ $$
\end{align*}
$$

where $f(x, u, \Delta t, t)$ is an abuse-of-notaton denoting the solution to an ODE, $\dot{x} = f(x, u, t)$, over the time interval $[t, t + \Delta t]$.
where each $r_k(x, u)$ is a user-defined residual function and $f(x, u, \Delta t, t)$ is an abuse-of-notaton denoting the solution to an ODE of the form $\dot{x} = f(x, u, t)$ over the time interval $[t, t + \Delta t]$.


<!-- TrajectoryBundles.jl is a Julia package that provides a high-level interface for defining, solving, and visualizing trajectory optimization problems using the trajectory bundle method. -->

**TrajectoryBundles.jl** uses
**TrajectoryBundles.jl** utilizes
- [NamedTrajectories.jl](https://github.com/kestrelquantum/NamedTrajectories.jl) to define, manipulate, and plot trajectories
- [OrdinaryDiffEq.jl](https://github.com/SciML/OrdinaryDiffEq.jl), [DiffEqGPU.jl](https://github.com/SciML/DiffEqGPU.jl), and [CUDA.jl](https://github.com/JuliaGPU/CUDA.jl) to solve the underlying ODEs
- [Convex.jl](https://github.com/jump-dev/Convex.jl) and [Clarabel.jl](https://github.com/oxfordcontrol/Clarabel.jl) for solving the underlying quadratic program
Expand Down

2 comments on commit fa768cc

@aarontrowbridge
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

Release notes:

Breaking Changes

  • dynamics must now be pass as implicit functions
  • new key word args

Change Log

  • GPU support enabled
  • commented example

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/125396

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v0.1.0 -m "<description of version>" fa768ccf772f30efb0adcf205d52656df00b4241
git push origin v0.1.0

Please sign in to comment.