Skip to content

Commit

Permalink
Merge pull request #26 from tjstienstra/dev-version
Browse files Browse the repository at this point in the history
Dev version
  • Loading branch information
tjstienstra authored Feb 5, 2024
2 parents df77c35 + 3f7fbd5 commit 00bec18
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 11 deletions.
2 changes: 0 additions & 2 deletions .github/release-drafter.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ categories:
- 'bug'
- title: '🧰 Maintenance'
label: 'chore'
- title: '📚 Documentation'
label: 'documentation'
- title: '💥 Breaking Changes'
label: 'breaking'
change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
Expand Down
13 changes: 6 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,20 +13,19 @@ SymMePlot enhances this process by providing a way to visualize these constructe
objects. It integrates with visualization backends like [Matplotlib], and creates visual
representations based on the parametrization of the symbols involved in the system.

To install `symmeplot` with the `matplotlib` visualization run:

SymMePlot is available on both PyPI and Conda-Forge. To install the latest release
including [Matplotlib] from PyPI, run: ::
```bash
pip install symmeplot matplotlib
```

## Usage
Most of your programs are expected to follow this structure:
1. Creation of the system in sympy using the objects from `sympy.physics.mechanics`.
2. Create a figure with a 3D axes with `matplotlib`.
3. Initiate a `Scene` with the inertial frame and absolute origin.
4. Add your frames, vectors and points to the plotter instance.
5. Lambdify and evaluate the system.
6. Plot the system.
2. Initiate a `Scene` with the inertial frame and absolute origin.
3. Add your frames, vectors and points to the plotter instance.
4. Lambdify and evaluate the system.
5. Plot the system.

Below is a basic example of how this looks in practise:
```python
Expand Down
3 changes: 2 additions & 1 deletion docs/guides/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ Installation
Installation Users
------------------

SymMePlot is available on PyPI. You can install it using: ::
SymMePlot is available on both PyPI and Conda-Forge. To install the latest release from
PyPI, run: ::

pip install symmeplot

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "symmeplot"
version = "0.2.1"
version = "0.2.2.dev"
description = "SymPy Mechanics Plotter"
authors = ["tjstienstra <timostienstra00@gmail.com>"]
readme = "README.md"
Expand Down

0 comments on commit 00bec18

Please sign in to comment.