Skip to content

Commit e3590f1

Browse files
committed
Divide systems into subpages
1 parent 2c853d9 commit e3590f1

15 files changed

+365
-26
lines changed

docs/api/integration.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Integration Utilities
2+
3+
Numerical integration methods and utilities for solving differential equations.
4+
5+
## Overview
6+
7+
This module provides various integration schemes including Gauss-Legendre quadrature and other numerical methods used in the robot dynamics computations.
8+
9+
## API Reference
10+
11+
::: jsrm.integration
12+
options:
13+
show_root_heading: true
14+
show_source: false
15+
heading_level: 3
16+
group_by_category: true
17+
docstring_section_style: table
18+
members_order: source

docs/api/math-utils.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Math Utilities
2+
3+
Mathematical utility functions used throughout JSRM for various computations.
4+
5+
## Overview
6+
7+
This module provides core mathematical operations including linear algebra utilities, matrix operations, and specialized functions for robotics computations.
8+
9+
## API Reference
10+
11+
::: jsrm.math_utils
12+
options:
13+
show_root_heading: true
14+
show_source: false
15+
heading_level: 3
16+
group_by_category: true
17+
docstring_section_style: table
18+
members_order: source

docs/api/parameters.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Parameters
2+
3+
Parameter handling and configuration utilities for robot systems.
4+
5+
## Overview
6+
7+
This module provides functions for handling robot parameters, including validation, conversion, and default parameter sets for various robot types.
8+
9+
## API Reference
10+
11+
::: jsrm.parameters
12+
options:
13+
show_root_heading: true
14+
show_source: false
15+
heading_level: 3
16+
group_by_category: true
17+
docstring_section_style: table
18+
members_order: source

docs/api/pcs.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# PCS Systems (General)
2+
3+
The general Piecewise Constant Strain (PCS) implementation provides the core modeling framework for continuum soft robots.
4+
5+
## Overview
6+
7+
This module contains the fundamental PCS implementation that serves as the foundation for more specialized PCS variants. It provides the core mathematical framework for modeling continuum robots using piecewise constant strain assumptions.
8+
9+
## API Reference
10+
11+
::: jsrm.systems.pcs
12+
options:
13+
show_root_heading: true
14+
show_source: false
15+
heading_level: 3
16+
group_by_category: true
17+
docstring_section_style: table
18+
members_order: source

docs/api/pendulum.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Pendulum Systems
2+
3+
The pendulum module provides implementations for N-link pendulum systems, which are useful for benchmarking and comparison with soft robot systems.
4+
5+
## Overview
6+
7+
The pendulum system implements classical rigid-body dynamics for articulated robots with revolute joints. This serves as a baseline for comparing with continuum soft robot models.
8+
9+
## API Reference
10+
11+
::: jsrm.systems.pendulum
12+
options:
13+
show_root_heading: true
14+
show_source: false
15+
heading_level: 3
16+
group_by_category: true
17+
docstring_section_style: table
18+
members_order: source

docs/api/planar-hsa.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Planar HSA Systems
2+
3+
The Planar Handed Shearing Auxetics (HSA) systems provide implementations for soft robots with auxetic properties in planar settings.
4+
5+
## Overview
6+
7+
HSA robots exhibit unique mechanical properties due to their auxetic structure, which allows for interesting deformation patterns and control strategies. This module implements the kinematic and dynamic models for planar HSA robots.
8+
9+
## API Reference
10+
11+
::: jsrm.systems.planar_hsa
12+
options:
13+
show_root_heading: true
14+
show_source: false
15+
heading_level: 3
16+
group_by_category: true
17+
docstring_section_style: table
18+
members_order: source

docs/api/planar-pcs-sym.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Planar PCS Symbolic Systems
2+
3+
The symbolic implementation of Planar PCS systems provides pre-computed symbolic expressions for kinematics and dynamics, offering improved computational performance.
4+
5+
## Overview
6+
7+
This module contains symbolic derivations of the PCS model equations, which are pre-computed using SymPy and then implemented in JAX for fast execution. This approach eliminates the need for numerical differentiation during runtime.
8+
9+
## API Reference
10+
11+
::: jsrm.systems.planar_pcs_sym
12+
options:
13+
show_root_heading: true
14+
show_source: false
15+
heading_level: 3
16+
group_by_category: true
17+
docstring_section_style: table
18+
members_order: source

docs/api/planar-pcs.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Planar PCS Systems
2+
3+
The Planar Piecewise Constant Strain (PCS) systems provide implementations for 2D soft continuum robots using the Cosserat rod theory with piecewise constant strain assumptions.
4+
5+
## Overview
6+
7+
The PCS model divides the continuum robot into segments, each with constant strain properties. This approach provides a good balance between computational efficiency and modeling accuracy for soft continuum robots.
8+
9+
## Main Implementation
10+
11+
::: jsrm.systems.planar_pcs
12+
options:
13+
show_root_heading: true
14+
show_source: false
15+
heading_level: 3
16+
group_by_category: true
17+
docstring_section_style: table
18+
members_order: source

docs/api/pneumatic-planar-pcs.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Pneumatically Actuated Planar PCS
2+
3+
Pneumatically actuated Planar PCS systems with pressure-based actuation mechanisms.
4+
5+
## Overview
6+
7+
This module extends the planar PCS model to include pneumatic actuation, where the robot is actuated by controlling internal pressure in chambers or bellows. This actuation method is common in soft pneumatic robots.
8+
9+
## API Reference
10+
11+
::: jsrm.systems.pneumatically_actuated_planar_pcs
12+
options:
13+
show_root_heading: true
14+
show_source: false
15+
heading_level: 3
16+
group_by_category: true
17+
docstring_section_style: table
18+
members_order: source

docs/api/rendering.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Rendering
2+
3+
Visualization and rendering utilities for robot systems.
4+
5+
## Overview
6+
7+
This module provides tools for visualizing robot configurations, trajectories, and animations. Includes both 2D and OpenCV-based rendering capabilities.
8+
9+
## API Reference
10+
11+
::: jsrm.rendering
12+
options:
13+
show_root_heading: true
14+
show_source: false
15+
heading_level: 3
16+
group_by_category: true
17+
docstring_section_style: table
18+
members_order: source

0 commit comments

Comments
 (0)