Installation¶
We recommend the conda package manager and the Anaconda or Miniconda distributions for easy cross platform installation.
Once Anaconda (or Miniconda) is installed type:
$ conda install -c conda-forge pydy
Also, a simple way to install all of the optional dependencies is to install
the pydy-optional
metapackage using conda:
$ conda install -c conda-forge pydy-optional
Note that pydy-optional
currently enforces the use of Jupyter 4.0, so you
may not want to install into your root environment. Create a new environment
for working with PyDy examples that use the embedded Jupyter visualizations:
$ conda create -n pydy -c conda-forge pydy-optional
$ conda activate pydy
(pydy)$ python -c "import pydy; print(pydy.__version__)"
Other installation options¶
If you have the pip package manager installed you can type:
$ pip install pydy
Installing from source is also supported. The latest stable version of the package can be downloaded from PyPi1:
$ wget https://pypi.python.org/packages/source/p/pydy/pydy-X.X.X.tar.gz
- 1
Change
X.X.X
to the latest version number.
and extracted and installed2:
$ tar -zxvf pydy-X.X.X.tar.gz
$ cd pydy-X.X.X
$ python setup.py install
- 2
For system wide installs you may need root permissions (perhaps prepend commands with
sudo
).
Dependencies¶
PyDy has hard dependencies on the following software3:
- 3
We only test PyDy with these minimum dependencies; these module versions are provided in the Ubuntu 20.04 packages. Previous versions may work.
Python >= 3.7
setuptools >= 44.0.0
NumPy_ >= 1.16.5
SciPy_ >= 1.3.3
SymPy_ >= 1.5.1
PyWin32 >= 219 (Windows Only)
PyDy has optional dependencies for extended code generation on:
and animated visualizations with Scene.display_jupyter()
on:
Jupyter Notebook >= 6.0.0 or Jupyter Lab >= 1.0.0
ipywidgets_ >= 6.0.0
pythreejs_ >= 2.1.1
or interactive animated visualizations with Scene.display_ipython()
on:
4.0.0 <= Jupyter Notebook < 5.0.0
4.0.0 <= ipywidgets_ < 5.0.0
The examples may require these dependencies:
matplotlib_ >= 3.1.2