From d44f85fdccc62d5963948fc485843220af2d67e9 Mon Sep 17 00:00:00 2001 From: Michael DM Dryden Date: Fri, 16 Jun 2017 15:26:43 -0400 Subject: [PATCH] Update README.markdown: Added upgrade instructions --- README.markdown | 48 ++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 38 insertions(+), 10 deletions(-) diff --git a/README.markdown b/README.markdown index 978120a..ed2fdb5 100644 --- a/README.markdown +++ b/README.markdown @@ -14,6 +14,7 @@ It currently has no abilities for analyzing recorded data or opening previously 2. [Old Homebrew Instructions](#old-homebrew-instructions) 1. [Linux](#linux) 2. [Windows](#windows) + 3. [Upgrading](#upgrading) 2. [Getting Started](#Getting-Started) # Introduction @@ -40,10 +41,12 @@ dstat-interface has moved to gtk+3 and we now recommend Anaconda/Miniconda for i #### Old Homebrew Instructions The easiest way to get most of the necessary requirements to run dstat-interface is using [Homebrew](http://brew.sh): - brew tap homebrew/python - brew update - brew install python gobject-introspection gtk+3 pygobject3 py2cairo scipy zeromq - brew install matplotlib --with-pygtk +```shell +brew tap homebrew/python +brew update +brew install python gobject-introspection gtk+3 pygobject3 py2cairo scipy zeromq +brew install matplotlib --with-pygtk +``` Be patient on the last step—matplotlib needs to be compiled and may take 2 or 3 minutes. @@ -58,22 +61,24 @@ Linux prerequisite installation is similar to that of MacOS with Homebrew, only These instructions were tested on Ubuntu 17.04: -```` +````shell sudo apt-get install gobject-introspection python-gobject python-pip pip install dstat-interface ```` You will need to add your user to the `dialout` group to access virtual serial ports (replace with your username): - sudo usermod -a -G dialout +```shell +sudo usermod -a -G dialout +``` ## Windows The following terminal commands will result in a full installation of dstat-interface and its requirements, assuming [64-bit Miniconda][1] is installed: -```` +```shell conda create -n dstat -c mdryden python=2 dstat-interface activate dstat -```` +``` To finish the installation, GTK+3 and its Python bindings must be installed: @@ -91,12 +96,35 @@ and `deactivate` will return to the root environment. Therefore, to run dstat-interface from our environment, we must first activate it (if not already done) before launching it: - activate dstat - python -m dstat_interface.main +```shell +activate dstat +python -m dstat_interface.main +``` [1]: https://repo.continuum.io/miniconda/Miniconda2-latest-Windows-x86_64.exe [2]: https://sourceforge.net/projects/pygobjectwin32/ +## Upgrading + +Anaconda builds can be upgraded to the latest version by issuing this command (from an activated conda environment): + +```shell +conda upgrade -c mdryden dstat-interface # For MacOS, be sure to upgrade dstat-interface-deps as well +``` + +pip installs can be upgraded similarly: + +```shell +pip install --upgrade dstat-interface +``` + +You can also run development builds directly from a cloned git repository (from an activated conda environment): + +```shell +cd ~/src/dstat-interface/dstat_interface # Replace with path to dstat_interface folder inside repository +python -m main +``` + # Getting started ## Interface overview -- GitLab