Skip to content

DeepHorizons/davitpy

 
 

Repository files navigation

DaViT-py

This is the ongoing development of a python alternative to the Data Visualization Toolkit for SuperDARN data analysis and visualization.

If you get a Bus Error when using radDataRead() and/or radDataReadRec() functions, you probably have to recompile the dmapio library on your local computer. This can be done by going to davitpy/pydarn/dmapio and typing 'make clean' followed by 'make'.

Install instructions

Note that we have developed using python 2.7. If you use a different version, the code will probably not work.

You will need RST to read standard SuperDARN dmap files. You will find a stripped down version of RST here: https://github.com/vtsuperdarn/RSTLite

If you have a Mac, make sure you have macports installed.

Then, clone this repository:

git clone https://github.com/vtsuperdarn/davitpy.git

Then cd into the cloned directory:

cd davitpy

Then run the install scripts specific to your system. These install dependencies and can take a bit of time...

####Ubuntu

cd install/debian/
sudo ./python_install_debian.sh

####MacOS

cd install/mac

If you are a MacPort user

sudo ./python_install_mac_port.sh

(note: you may encounter some errors because sometimes macport will install binaries with the python version as an extension in their name, so f2py becomes f2py-2.7. If this happens, you will have to manually create symbolic links to the *-2.7 binaries)

If you are a Homebrew user

sudo ./python_install_mac_brew.sh

####openSUSE

cd install/opensuse
sudo ./python_install_opensuse.sh

####Finally

Now, source ~/.bashrc, or open a new terminal. Then, go to your install directory (davitpy) and run

./mastermake

If you are not running Ubuntu or MacOS or openSUSE, you can manually install the dependencies listed in the python_install_*.sh, and edit your profile. Alternatively, you could write a script for your specific OS, and send it to us so that we can add it to the repository!

Now you are ready to go. From anywhere on your machine just type:

davitpy

for the interactive terminal, or

davitpy-notebook

for the notebook, or

davitpy-qtconsole

for the QT console. And code away!

Using the example notebooks

In docs/notebook you will find a small collection of notebooks demonstrating the main modules of DaViTpy (see also the documentation: http://davit.ece.vt.edu/davitpy/). Go to that directory and run

davitpy-notebook

Issues and Bug reporting

Please report any problems/comments using the Issues tab of the davitpy GitHub page, or use this link: https://github.com/vtsuperdarn/davitpy/issues