Installation

Installing pvpumpingsystem can be done through different processes. Two of them are detailled here, mainly thought for newcomers. Experienced users can modify it to their liking.

For people uncomfortable with package management, but who still plan on contributing or editing the code, follow the Install pvpumpingsystem with Anaconda and Git instructions to install pvpumpingsystem along with Anaconda and Git.

For people only interested in the use of the package, follow the Install pvpumpingsystem alone instructions to install pvpumpingsystem alone.

Installing pvpumpingsystem is similar to installing most scientific python packages, so in case of trouble see the References section for further help.

Please see the Compatibility section for information on the optional packages that are needed for some pvpumpingsystem features.

Install pvpumpingsystem with Anaconda and Git

  • Anaconda:

The Anaconda distribution is an open source distribution providing Python and others softwares and libraries useful for data science. Anaconda includes many of the libraries needed for pvpumpingsystem (Pandas, NumPy, SciPy, etc). Anaconda is especially recommended when using Windows.

Anaconda Python distribution is available at https://www.anaconda.com/download/.

See What is Anaconda? and the Anaconda Documentation for more information.

  • Git:

Git is a version control system that widely help contribution and development for open source softwares. Git should be native on most of Linux distribution, but must be installed on Windows.

Git for Windows is available at https://gitforwindows.org/.

  • pvpumpingsystem:

Once you have Anaconda and git installed, open a command line interface (‘Anaconda Prompt’ on Windows, terminal in Linux and macOS), change directory to the one you want to install pvpumpingsystem in, and type:

pip install -e git+https://github.com/tylunel/pvpumpingsystem#egg=pvpumpingsystem
  • Test pvpumpingsystem:

To ensure pvpumpingsystem and its dependencies are properly installed, run the tests by going to the directory of pvpumpingsystem and by running pytest:

cd <relative/path/to/pvpumpingsystem/directory>
pytest

Install pvpumpingsystem alone

Note

Even if you decide not to use Anaconda or Git, you minimally need a Python version superior to 3.5, and to have pip and setuptools installed (installed by default with recent version of Python).

This second option simply uses pip:

pip install pvpumpingsystem

If you have troubles with the use of pip, here is the pip documentation to help you.

To ensure pvpumpingsystem and its dependencies are properly installed, you can consult the package information through pip:

pip show pvpumpingsystem

Compatibility

pvpumpingsystem is compatible with Python 3.5 and above.

Besides the libraries contained in Anaconda, pvpumpingsystem also requires:

  • pvlib-python
  • fluids
  • numpy-financial

The full list of dependencies is detailled in setup.py.

References

Note

This section was adapted from the pvlib-python documentation. Thanks to them for this useful listing!

Here are a few recommended references for installing Python packages:

Here are a few recommended references for git and GitHub: