Skip to content

What is Pyslvs?

pyslvs-icon Pyslvs [`paɪsɑlvz] is an open source planar linkage mechanism simulation and mechanical synthesis system, which is named from “Python” and “Solvers”.

Pyslvs only has kinematics simulation right now.

The project is maintained on GitHub: https://github.com/KmolYuan/Pyslvs-UI

See the Windows platform testing on AppVeyor: Build status

See the Ubuntu and macOS platform testing on Travis CI: Build status

Install

Note

Feel free to uninstall Pyslvs by uninstall guide.

Warning

Pyslvs requires Python 3.7 or above.

Pyslvs-UI from PyPI: PyPI

Pyslvs from PyPI: PyPI

pip install pyslvs-ui
# Extras
pip install pyslvs-ui[slvs,scipy]

Download Pyslvs from GitHub release page, which can be executed directly without Python interpreter.

I hope your platform is supported, if not, please try another way or help me improve my Continuous Deployment process.

Recommended for developers. If you want an open source version, please clone it from GitHub then follow the develop environment guide and execute the launcher.

Or, install it with setuptools. The kernels will installed by pip. (Only for stable version!)

pip install -e .

Note

Pyslvs-UI is an universal (pure Python) package, which is cross-platform.

But the core kernel is installed from PyPI, Windows and macOS platform are packed as wheels, Linux platform will build from source code.

Extras

The pip extra requirements supports some functions on Pyslvs GUI.

  • Python-Solvespace PyPI: Support Solvespace kernel under GPLv3. ([slvs])
  • SciPy: Support B-Spline curve fitting function. ([scipy])

Startup

After installed package, Pyslvs provides a launcher command pyslvs for your terminal. The command python -m pyslvs_ui or write a python script also works:

from pyslvs_ui.__main__ import main
main()

For convenience, the file name of distributions can be renamed as pyslvs.exe, pyslvs.app or pyslvs.AppImage, the suffix is depended on your platform.

Here’s some command line options for Pyslvs executable.

# Open GUI directly
pyslvs

# Open GUI with Fusion style
pyslvs --fusion

# See the help
pyslvs --help

Python libraries has some dependencies with the compile environment, so the sources need to packed the Python installation and its libraries. But the source code is presented as plain text, which causes the size of AppImage is larger than other platforms.

Here’s some options for AppImage release pyslvs.AppImage for Ubuntu platform.

# Run it as a normal executable
chomod +x pyslvs.AppImage
./pyslvs.AppImage

# Unzip the package to "squashfs-root"
# There is including the source code of Pyslvs
./pyslvs.AppImage --appimage-extract

You can refer other AppImage options from its user guide.

Some options for Pyslvs repository.

For more environment information, please see Environment section.

# Download / update submodule
git submodule update --init --recursive

# Install dependencies
pip install -e .

# Open GUI by Python
python pyslvs_ui

For more details, please see the command set.

Uninstall

For PyPI package, uninstall Pyslvs-UI and its kernels by pip.

pip uninstall pyslvs-ui pyslvs python-solvespace

For other distributions, just delete the file or repository.


Last update: January 21, 2021