Chilipp/psyplot-conda: v1.0.1: Conda installers for psyplot - The interactive visualization framework

psyplot-conda provides standalone installers for the psyplot interactive visualization framework.

psyplot is an open source python project that mainly combines the plotting utilities of matplotlib (Hunter, 2007) and the data management of the xarray package (Hoyer & Hamman, 2017). The main purpose is to have a framework that allows a  fast, attractive, flexible, easily applicable, easily reproducible and especially an interactive visualization of your data.

The ultimate goal is to help scientists and especially climate model developers in their daily work by providing a flexible visualization tool that can be enhanced by their own visualization scripts. psyplot can be used through the python command line and through the psyplot-gui module which provides a graphical user interface for an easier interactive usage.

These installers contains all necessary dependencies for psyplot, psyplot-gui, psy-simple, psy-maps and psy-reg plus the conda package for managing virtual environments. The installers have been created using using the conda constructor package and the packages from the conda-forge channel.

Other ways to install psyplot can be found in the psyplot docs: http://psyplot.readthedocs.io

Source files

These files contain the source python code for the psyplot-conda repository (tag v1.0.1) and it's submodules psyplot (tag v1.0.0), psy-simple (tag v1.0.0), psy-maps (tag v1.0.0), psy-reg (tag v1.0.0) and psyplot-gui (tag v1.0.1).

• psyplot-conda-1.0.1.zip: The zipped source files including reference figures for psy-simple and psy-maps
• psyplot-conda-1.0.1-no-refs.zip: The zipped source files without reference figures

Documentation files

These files contain the documentation for psyplot, psy-maps, psy-reg, psy-simple and psyplot-gui from http://psyplot.readthedocs.io/en/latest/, downloaded on August, 21st, 2017.

• docs-epub.zip: Documentation files in epub format
• docs-pdf.zip: Documentation files in pdf format
• docs-html.zip: Documentation files in html format

Standalone installers

These installers have been created using the conda constructor package and can be used to install psyplot, psy-simple, psy-maps, psy-reg and psyplot-gui. Installation instructions can be found in the Additional Notes.

• psyplot-conda-1.0.1-Linux-x86-64.sh: Bash installer for 64-bit Linux systems
• psyplot-conda-1.0.1-MacOSX-x86-64.sh: Bash installer for 64-bit Mac OS X systems
• psyplot-conda-1.0.1-MacOSX-x86-64.pkg: Package installer for 64-bit Mac OS X systems
• psyplot-conda-1.0.1-Windows-x86-64.exe: Windows installer for 64-bit systems
• psyplot-conda-1.0.1-Windows-x86.exe: Windows installer for 32-bit systems
• psyplot-conda-1.0.1-Windows-no-shortcut-x86-64.exe: Windows installer for 64-bit systems without menu shortcut
• psyplot-conda-1.0.1-Windows-no-shortcut-x86.exe: Windows installer for 32-bit systems without menu shortcut

Packages

These files contain packages for psyplot (1.0.0.post1), psy-simple (1.0.0), psy-maps (1.0.0), psy-reg (1.0.0) and psyplot-gui (1.0.1).

• python-packages.zip: Python packages from pipy.org
• conda-packages.zip: Conda packages from https://anaconda.org/conda-forge

 

Installation instructions for standalone installers

Installation on Linux

Download the bash script and open a terminal window.

Type:

bash '<path-to-the-downloaded-file.sh>'

and simply follow the instructions.

For more information on the command line options type:

bash '<Path-to-the-downloaded-file.sh>' --help

It will ask you, whether you want to add a psyplot alias to your .bashrc, such that you can easily start the terminal and type psyplot to start the GUI. You can avoid this by setting NO_PSYPLOT_ALIAS=1. Hence, to install psyplot-conda without any terminal interaction, run:

NO_PSYPLOT_ALIAS=1 bash '<Path-to-the-downloaded-file.sh>' -b -p <target-path>

Uninstallation on Linux

Just delete the folder where you installed psyplot-conda. By default, this is $HOME/psyplot-conda, so just type:

rm -rf $HOME/psyplot-conda

If you added a psyplot alias to your .bashrc or chose to add the bin directory to your PATH variable during the installation, open your $HOME/.bashrc in an editor of your choice and delete those parts.

Installation on OS X

You can either install it from the terminal using a bash-script (.sh file), or you can install a standalone app using an installer (.pkg file).

The bash script will install a conda installation in your desired location. Both will create a Psyplot.app (see below).

Installation using the OS X package

This should be straight-forward, however Apple does not provide free Developer IDs for open-source developers. Therefore our installers are not signed and you have to give the permissions to open the files manually. The 4 steps below describe the process.

1. Just download the .pkg file
2. To open it, you have to

 Right-click on the file, then Open With, then Installer. In the appearing window, click the Open button.

1. Follow the instructions. It will create a Psyplot.app in the specified location.
2. To open the app the first time, change to the chosen installation directory for the App (by default $HOME/Applications), right-click the Psyplot app and click on Open. In the appearing window, again click on Open.

Installation using the bash script

Download the bash script (file ending on '.sh' for MacOSX) and open a terminal window.

Type:

bash '<path-to-the-downloaded-file.sh>'

and simply follow the instructions.

For more informations on the command line options type:

bash '<Path-to-the-downloaded-file.sh>' --help

By default, the installer asks whether you want to install a Psyplot.app into your Applications directory. You can avoid this be setting NO_PSYPLOT_APP=1.

Furthermore it will ask you, whether you want to add a psyplot alias to your .bash_profile, such that you can easily start the terminal and type psyplot to start the GUI. You can avoid this by setting NO_PSYPLOT_ALIAS=1. Hence, to install psyplot-conda without any terminal interaction, run:

NO_PSYPLOT_APP=1 NO_PSYPLOT_ALIAS=1 bash '<Path-to-the-downloaded-file.sh>' -b -p <target-path>

Uninstallation on OSX

The uninstallation depends on whether you have used the package installer or the bash script for the installation.

Uninstall the App installed through the OS X package

Just delete the app from your Applications folder. There have been no changes made to your PATH variable.

Uninstall the App installed via bash script

As for linux, just delete the folder where you installed psyplot-conda. By default, this is $HOME/psyplot-conda. Open a terminal and just type:

rm -rf $HOME/psyplot-conda

If you added a psyplot alias to your .bash_profile or chose to add the bin directory to your PATH variable during the installation, open your $HOME/.bash_profile in an editor of your choice and delete those parts.

If you chose to add a Psyplot app, just delete the symbolic link in /Applications or $HOME/Applications.

Installation on Windows

Just download the installer for 64-bit or 32-bit, double click the downloaded file and follow the instructions. The installation will create an item in the windows menu (Start -> Programs -> Psyplot) which you can use to open the GUI. You can, however, also download installers that create no shortcut from below.

In any case, if you chose to modify your PATH variable during the installation, you can open a command window (cmd) and type psyplot.

Uninstallation on Windows

Just double-click the Uninstall-Anaconda.exe file in the directory where you installed psyplot-conda and follow the instructions.

This will also revert the changes in your PATH variable.

Acknowledgements

The author thanks the Swiss National Science Foundation (SNF) for their support. Funding for the author came from the ACACIA grant (CR10I2_146314) and the HORNET grant (200021_169598).