Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create consistent formatting for all examples in the gallery #348

Open
15 of 23 tasks
moorepants opened this issue Feb 10, 2025 · 0 comments
Open
15 of 23 tasks

Create consistent formatting for all examples in the gallery #348

moorepants opened this issue Feb 10, 2025 · 0 comments

Comments

@moorepants
Copy link
Member

moorepants commented Feb 10, 2025

Here is a suggestion:

Title
=====

.. note:: installation note

Objectives
----------

Introduction
------------

Other headings as needed
------------------------

The objectives section would list the purpose and unique aspects of the example.

I basically have this in the park2004 example: https://opty.readthedocs.io/latest/examples/advanced/plot_park2004.html

We should also try to consistently use the mathematical notation in the theory page. I also tried this in the park 2004 example.

  • plot_ball_rolling_on_spinning_disc.py
  • plot_car_around_pylons.py
  • plot_car_in_garage.py
  • plot_human_gait.py
  • plot_one_legged_time_trial.py
  • plot_park2004.py
  • plot_particle_in_tube.py
  • plot_sit_to_stand.py
  • plot_betts_10_103_104.py
  • plot_betts_10_50.py
  • plot_betts_10_7.py
  • plot_betts2003.py
  • plot_pendulum_swing_up_fixed_duration.py
  • plot_pendulum_swing_up_variable_duration.py
  • plot_sliding_block.py
  • plot_vyasarayani.py
  • plot_countersteer.py
  • plot_crane_moving_a_load.py
  • plot_drone.py
  • plot_mississippi_steamboat.py
  • plot_non_contiguous_parameter_identification.py
  • plot_parallel_park.py
  • plot_two_link_pendulum_on_a_cart.py
Peter230655 added a commit to Peter230655/opty that referenced this issue Feb 10, 2025
moorepants added a commit that referenced this issue Feb 10, 2025
added more textrm, first attempt at structure as per #348
moorepants added a commit that referenced this issue Feb 22, 2025
make docstrings as per #348, skip solve if solution is available
Peter230655 added a commit to Peter230655/opty that referenced this issue Feb 22, 2025
moorepants added a commit that referenced this issue Feb 22, 2025
Peter230655 added a commit to Peter230655/opty that referenced this issue Feb 22, 2025
moorepants added a commit that referenced this issue Feb 26, 2025
docstrings as per #348, backend=numpy, additional state variables
Peter230655 added a commit to Peter230655/opty that referenced this issue Feb 27, 2025
Peter230655 added a commit to Peter230655/opty that referenced this issue Feb 27, 2025
moorepants added a commit that referenced this issue Feb 27, 2025
docstrings as per #348, backend= nzmpy, reduced frames
moorepants added a commit that referenced this issue Feb 27, 2025
moorepants added a commit that referenced this issue Feb 28, 2025
docstrings as per #348, backend=numpy, store solution, reduce fps
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant