Install EasyIDP#

EasyIDP Python packages are distributed via PyPI.

Supported Python versions:

  • 3.8

  • 3.9

Supported operating systems:

  • Windows 10 (64-bit)

  • Windows 11 (64-bit)

  • macOS 10.15+

  • Manjaro

The following operating system should also works, but have not been tested:

  • Ubuntu 18.04+

  • ArchLinux

Using this package requires basic Python programming knowledge, including basic python gramma and package installation.

Install from PyPI#

Here assuming the user has python3 and pip installed in the computer, and in the command line, the following operation works:

C:\Users\xxx> python --version
Python 3.7.3
C:\Users\xxx> pip --version
pip 19.2.3

Then install the package by:

pip install easyidp

Note

In general, we recommend using a virtual environment or conda environment to avoid dependices conflict with your local environment.

Please refer Use Virtual Environment for more details.

For Linux users, depending on the configurations, pip3 may be needed for Python 3, or the --user option may need to be used to avoid permission issues. For example:

pip3 install easyidp
# or
pip install --user easyidp
# or
python3 -m pip install --user easyidp

Tip

For users in China, it is recommended to use Tsinghua source to accelerate the download speed:

> pip install easyidp -i https://pypi.tuna.tsinghua.edu.cn/simple

Using from source code#

If you need to make some changes to the source code (e.g. fix bugs) and want it work immediately (rather than waiting for offical fix). You can also using from the source code directly.

Tip

Please ensure you have uninstalled the pypi easyidp in your current environment:

pip uninstall easyidp

and need to restart python to make changes taking effects.

Assuming the source package was downloaded in C:\path\to\source\code\EasyIDP and the code folder has the following files:

C:\path\to\source\code\EasyIDP
├─ docs/
├─ easyidp/
├─ tests/
readme.md
setup.py
...

Then you can used the following code to manual import easyidp package:

import sys
sys.path.insert(0, r'C:/path/to/source/code/EasyIDP')

import easyidp as idp

Or install to your virtual environment by:

> cd "C:/path/to/source/code/EasyIDP"   # contains setup.py
> pip install -e .