To use FMPy you need Python. If you do not have a Python environment on your machine you can install Anaconda that comes with a range of packages for scientific computing. If you want to install your packages individually you can use Miniconda.
Depending on what you intent to use FMPy for you might only need certain packages.
| Function | Required packages |
|---|---|
| Read modelDescription.xml | lxml |
| Simulate FMUs | numpy, pywin32 (only on Windows) |
| Plot results | matplotlib |
| Parallelization example | dask |
| Download example FMUs | requests |
| Graphical user interface | pyqt, pyqtgraph |
To install FMPy from conda-forge including all dependencies type
conda install -c conda-forge fmpyTo install FMPy w/o dependencies type
conda install -c conda-forge fmpy --no-depsand install the dependencies with
conda install <packages>To install FMPy from PyPI including all dependencies type
python -m pip install fmpy[complete]To install FMPy w/o dependencies type
python -m pip install fmpy --no-depsand install the dependencies with
python -m pip install <packages>To install the latest development version directly from GitHub type
python -m pip install https://github.com/CATIA-Systems/FMPy/archive/develop.zipIf you don't have access to the internet or you're behind a firewall and cannot access PyPI.org or Anaconda Cloud directly you can download and copy the following files to the target machine:
- the Anaconda Python distribution
- the FMPy Conda package or Python Wheel
- the PyQtGraph Conda package or Python Wheel (only required for the GUI)
After you've installed Anaconda, change to the directory where you've copied the files and enter
conda install --no-deps fmpy-{version}.tar.bz2 pyqtgraph-{version}.tar.bz2
to install the Conda packages or the Python Wheels with
python -m pip install --no-deps FMPy-{version}.whl pyqtgraph-{version}.tar.gz
where {version} is the version you've downloaded.