Installing pyDARN


License: LGPL v3 Python 3.6 GitHub release (latest by date) DOI

Prerequisites

pyDARN requires python 3.6 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

Dependencies

pyDARN's setup will download the following dependencies:

Virtual Environments

It is recommended to install pyDARN 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 pyDARN developers:"

pip Virtual Environment

Instructions can be found here virtual environment

Option 1: 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 pydarn (Install pyDARN)

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 pydarn

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.
  3. If you don't see the environment you wish to use click the plus sign on the right side bar named "Add"
  4. Select "Conda Environment" on the left side menu.
  5. 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 pydarn

System Install

sudo pip3 install pydarn

Installing for Development

$ git clone https://github.com/superdarn/pydarn

Change directories to pydarn

$ git checkout develop

To install:

$ pip3 install . --user

Note

If pip --version is pointing to python 3.6+ then you can use pip install . --user instead.

Warning

Do not install pydarn with python setup.py install as this may install other libraries pydarn requires in a local directory causing issues down the road.

Troubleshooting

Pip3 installation with Ubuntu 20.4/python 3.8.4

Issue: pip3 install --user git+https://github.com/superdarn/pydarn@develop not working

Solution: 1. check git is installed apt install git (for ubuntu) 2. Check pip version pip --version - with newer distros of Linux/Virtual machines pip may point to pyhon3 and you will not need pip3. 3. Alternative virtual environment steps for getting python 3.8 working

$ sudo apt-get update
$ sudo apt-get install python3-virtualenv python3-pip
$ cd ~/
$ mkdir venvs
$ virtualenv -p python3.8 ~/venvs/py38
$ echo "source $HOME/venvs/py38/bin/activate" >> ~/.bashrc

Then open a new terminal and you should see (pyy38) in the prompt.

Credit to this solution is Ashton Reimer, more details on the issue #37

If you find any problems/solutions, please make a github issue so the community can help you or add it to the documentation