Installation¶
Pecos requires Python (tested on 3.6, 3.7, and 3.8) along with several Python package dependencies. Information on installing and using Python can be found at https://www.python.org/. Python distributions, such as Anaconda, are recommended to manage the Python interface. Anaconda Python distributions include the Python packages needed to run Pecos.
Pecos can be installed using pip, git, or a downloaded zip file.
pip: To install Pecos using pip:
pip install pecos
git: To install Pecos using git:
git clone https://github.com/sandialabs/pecos
cd pecos
python setup.py install
zip file: To install Pecos using a downloaded zip file, go to https://github.com/sandialabs/pecos, select the “Clone or download” button and then select “Download ZIP”. This downloads a zip file called pecos-master.zip. To download a specific release, go to https://github.com/sandialabs/pecos/releases and select a zip file. The software can then be installed by unzipping the file and running setup.py:
unzip pecos-master.zip
cd pecos-master
python setup.py install
Required Python package dependencies include:
Pandas [Mcki13]: used to analyze and store time series data, http://pandas.pydata.org/
Numpy [VaCV11]: used to support large, multi-dimensional arrays and matrices, http://www.numpy.org/
Jinja [Rona08]: used to generate HTML templates, http://jinja.pocoo.org/
Matplotlib [Hunt07]: used to produce figures, http://matplotlib.org/
Optional Python packages dependencies include:
minimalmodbus: used to collect data from a modbus device, https://minimalmodbus.readthedocs.io
sqlalchemy: used to insert data into a MySQL database, https://www.sqlalchemy.org/
pyyaml: used to store configuration options in human readable data format, http://pyyaml.org/
PVLIB [SHFH16]: used to simulate the performance of photovoltaic energy systems, http://pvlib-python.readthedocs.io/
Plotly [SPHC16]: used to produce interactive scalable figures, https://plot.ly/
All other dependencies are part of the Python Standard Library.
To use Pecos, import the package from a Python console:
import pecos