Installing pyCHIPS

---

Important

It is recommended to install pyCHIPS pip or pip3: pip install pyCHIPS

Prerequisites

scubas requires python 3.6 or later and matplotlib 3.3.4 or later.

Depending on your operating system or distribution, the following package installers, development environments or data parsers are required:

Ubuntu	OpenSuse	Fedora	OSX	Windows
libyaml-dev	python3-PyYAML	libyaml-devel	Xcode/pip	pip

You can check your python version using

$ python --version or $ python3 --version

Note

If you have already installed pyCHIPS you can use pip3 install --upgrade pyCHIPS

Dependencies

pychips's setup will download the following dependencies:

• Git (For developers)
• pip3
• NumPy
• SciPy
• matplotlib 3.3.4+
• pandas
• loguru
• SciencePlots
• SunPy
• AIAPy

Virtual Environments

It is recommended to install pyCHIPS in one of the suggested virtual environments if you have multiple python/pip 3 version on your computer, or do not want to affect the main system's python libraries.

The following virtual environments have been tested by pyCHIPS developers:"

pip Virtual Environment

Instructions can be found here virtual environment

1. $ python3 -m pip install --user virtualenv (Install virtual environment package)
2. $ python3 -m virtualenv <environment name> (Make your virtual environment)
3. $ source <environment name>/bin/activate (Activate the virtual environment)
4. $ pip install pyCHIPS (Install pyCHIPS)

Note

If you have multiple versions of python 3 on your machine, you can access a specific version by: python<version number>. For example, if you want to install python 3.6 virtual environment: python3.6 -m pip install --user virtualenv.

Anaconda Virtual Environment

Instructions can be found here conda environment and installing anaconda

1. $ conda create -n yourenvname python=3.7 anaconda
2. $ conda activate yourenvname
3. $ pip install pyCHIPS

Adding the environment to PyCharm

To set the project interpreter to the anaconda environment:

1. File -> Settings -> Project Folder -> Project Interpreter

2. Click the project Interpreter drop down list and click on show all.

   • If you don't see the environment you wish to use click the plus sign on the right side bar named "Add"
   • Select "Conda Environment" on the left side menu.
   • Click "Existing Environment" and give the interpreter field the path to your environment's python.exe and apply.

Local Install

pip3 install

pip3 install --user pyCHIPS

System Install

sudo pip3 install pyCHIPS