How to install symforce via python pip

- Intended Audience :: Education
- Intended Audience :: Science/Research
- License :: OSI Approved :: Apache Software License
- Programming Language :: C
- Programming Language :: C++
- Programming Language :: Python :: 3 :: Only
- Programming Language :: Python :: 3.1
- Programming Language :: Python :: 3.10
- Topic :: Education
- Topic :: Education :: Computer Aided Instruction (CAI)
- Topic :: Scientific/Engineering
- Topic :: Scientific/Engineering :: Artificial Intelligence
- Topic :: Scientific/Engineering :: Mathematics
- Topic :: Software Development :: Code Generators
- Topic :: Software Development :: Embedded Systems
- Topic :: Software Development :: Libraries :: Python Modules

When you know about this project and you want to new install symforce to support your project or you get trouble as ModuleNotFoundError: No module named "symforce" or ImportError: cannot import name "symforce" in your project, let follow this tutorial to install symforce

Installation:

Step 1: First, ensure you installed pip in your os, to check pip has been installed on your computer

In Windows (CMD):

py -m pip --version

In Unix/macOS:

python3 -m pip --version

Ensure pip, setuptools, and wheel are up to date:

In Windows (CMD):

py -m pip install --upgrade pip setuptools wheel

In Unix/macOS:

python3 -m pip install --upgrade pip setuptools wheel

py -m pip install --user virtualenv

py -m venv test_symforce_env

test_symforce_env\Scripts\active

pip3 install virtualenv

python3 -m venv test_symforce_env

source test_symforce_env/bin/active

Step 2: OK, now, let flow below content to start the installation symforce

To install symforce on Windows(CMD):

py -m pip install symforce

To install symforce on Unix/macOs:

pip install symforce

Step 3: If you want to install a specific symforce version, add ==<symforce version> to the end command line

Example:

pip install symforce==0.3.dev2                                                        pre-release

Please see the version list below table:

py -m pip install symforce==0.5.0

pip install symforce==0.5.0

py -m pip install symforce==0.4.0

pip install symforce==0.4.0

Step 4: Otherwise, you can install symforce from local archives:

Download the distribution file from symforce-0.5.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl or the specific symforce version in the below list of distribution

After that, install by command:

On Windows(CMD):

py -m pip install <path_to_symforce_downloaded_file>

On Unix/macOs:

pip install <path_to_symforce_downloaded_file>

List distribution:

Project link:

- Homepage
- Bug Tracker
- Source