Matlab®To Python: a Migration Guide 6

Total Page:16

File Type:pdf, Size:1020Kb

Matlab®To Python: a Migration Guide 6 White Paper MATLAB® to Python: A Migration Guide www.enthought.com Copyright © 2017 Enthought, Inc. written by alexandre chabot-leclerc All Rights Reserved. Use only permitted under license. Copying, sharing, redistributing or other unauthorized use strictly prohibited. All trademarks and registered trademarks are the property of their respective owners. matlab and Simulink are registered trademark of The MathWorks, Inc. Enthought, Inc. 200 W Cesar Chavez St Suite 202 Austin TX 78701 United States www.enthought.com Version 1.0, September 2017 Contents 1 Introduction5 Why Python6 Getting Started8 2 Differences Between Python and MATLAB® 10 Fundamental Data Types 10 Organizing Code in Packages, not Toolboxes 11 Syntax 12 Indexing and Slicing: Why Zero-Based Indexing 14 NumPy Arrays Are Not Matrices 16 Programming Paradigm: Object-Oriented vs. Procedural 19 3 How Do I? 22 Load Data 22 Signal processing 24 Linear algebra 25 Machine learning 25 Statistical Analysis 26 Image Processing and Computer Vision 26 Optimization 27 Natural Language Processing 27 Data Visualization 27 Save Data 30 What Else? 31 4 4 Strategies for Converting to Python 33 From the Bottom Up: Converting One Function at a Time 33 From the Top Down: Calling Python from MATLAB® 41 5 What Next? 46 Appendix 47 Code Example: Proling Contiguous Array Operations 47 Complete Version of main.py, in Chapter4 47 Anti-Patterns 49 References 51 1 Introduction This document will guide you through your transition from matlab® to Python. The first section presents some reasons why you would want to to do so as well as how to get started quickly by installing Enthought Canopy. Download Enthought Canopy at https: The second section highlights some of the most important dierences //store.enthought.com/downloads/. between the two languages, including the fundamental data types; how code is organized in packages; an overview of the syntax dierences; how indexing and slicing work; NumPy arrays; and how Python mainly uses an object-oriented programming paradigm. The third section is structured around vignettes for common tasks when doing data analysis or running simulations. The vignettes highlight the most common packages used for each task, such as loading data, cleaning and reformatting data, performing analysis or simulation, plotting, and saving data. The fourth section introduces two strategies to gradually transition to Python. Both rely on testing to validate that the new Python code works the same way (or is broken in the same way!) as your matlab® code. They approach the problem by either converting all function directly to Python or by calling Python from matlab®. You should use the one that is most convenient for your project. Who Is This Guide For This guide is for long time matlab® users who want to migrate to Python, either partially or completely. I once was such a person. Who Is This Document Not For If you rely heavily on the Simulink® graph- For a good discussion about Simulink® ical programming environment, you’re out of luck. There is no good alternatives, I recommend the article Free and commercial alternatives to Simulink on Simulink® equivalent in the Python ecosystem. If you have very special Mike Croucher’s blog, Walking Randomly. hardware integration needs, you might be able to find a package that works for you on the Python Package Index, but there is no guarantee that it will be actively maintained or that it will support all the features you need. However, there is nothing stopping you from implementing the fea- tures you need and sharing them with the world. Someone, somewhere, © Enthought, Inc. Accelerate your Python migration with Enthought’s Python for Scientists and Engineers training course! https://www.enthought.com/training/course/python-for-scientists-and-engineers matlab®to python: a migration guide 6 would surely be thankful for it. And finally, this is not the right document for you if you are new to programming. Hardware and Soware Requirements Nothing in this guide is platform specific. All the code is written to run under Python 3. At the time of writ- ing, the latest version is 3.6 but there is nothing in this guide that uses version-specific features. Conventions Used in This Document • Italic text is used for new terms, emphasis, and variables that do not appear in any code listing. • Constant width text is used for program listings, as well as within paragraphs to refer to program variables, functions, data types, key- words, etc. Why Python If you are reading this guide, I assume that you do not need to be con- vinced too hard to transition to Python. I will nonetheless go through some of the reasons why someone might want to switch from matlab® to Python. At the very least, it might help you convince someone else. I split the reasons into five dierent categories: financial, freedom, technical, social, and curiosity. Financial: Cost is oen the first reason given for switching away from matlab®. It is certainly a good reason. Licensing fees add up quickly, es- pecially if you rely on many toolboxes, and they might be a significant part of your budget if you are in a small organization. Python certainly has the appeal of being free, both as in “free beer”, or gratis and as in “free speech”. I’ll cover the free speech aspect in a moment. But to be honest, and to re- peat the adage: “There is no such thing as a free lunch”. It is true that when using Python you do not have to pay a license fee from anyone, and that you have access to many free open source packages. However, be aware of the transition “fee”. One day you are a good matlab® developer, and the next you are a mediocre (for now, but I am sure you will improve!) Python developer. The gamble is that Python will allow you to be more agile and productive in the long term, which many individuals and companies have shown. Freedom: Choosing Python, or any other open source language, lets you run your code “forever”. You are not locked-in with a given provider. There is no need to pay a license fee in order to keep your soware running. More importantly, it means that your colleagues, and people you don’t even © Enthought, Inc. Accelerate your Python migration with Enthought’s Python for Scientists and Engineers training course! https://www.enthought.com/training/course/python-for-scientists-and-engineers matlab®to python: a migration guide 7 know, can run your Python code without themselves buying a license. This can greatly improve the chances of survival of your project. Technical: Python has the benefit of being first and foremost a general purpose programming language. It does happen to be a great language for scientific computing, and it even has some features specifically for that, but it’s not only a scientific computing language. It can be used to do everything from building a file synchronization system (Dropbox), a photo- sharing service (Instagram), a 3-D modeling and video-editing application (Blender), a video hosting platform (YouTube), to discovering gravitational waves.1 1 Python was used in most components The consequence of such varied uses is that you can find tools to do of the Laser Interferometer Gravitational- Wave Observatory (LIGO) project. They almost all common tasks. It allows you to use Python for your entire ap- have created a very interesting collection plication, from hardware control and number crunching, to web API and of tutorials. desktop application. And for the cases when a feature or a library exists only in another language, Python is an excellent “glue” language. It can easily interface with C/C++ and Fortran libraries, and there are Python im- plementations for some of the major other languages, such as IronPython for C# and Jython for Java. Social: Maybe you have met a funny, clever and irresistible Pythonista at one of the many local meet-ups and thought you would check out their programming language of choice. The Python community is certainly a great reason to pick the language. There are the multiple PyCon confer- ences around the world, from the main one in North American, to PyCon Zimbabwe, Pycon Pakistan, and Kiwi PyCon. There are also the various SciPy conferences, which focus on the scientific Python ecosystem, or the PyData events about data science. I would be remiss if I failed to mention the PyLadies and Django Girls chapters around the world. Pick your lo- Django is a high-level Web framework, cation and your topic of choice and I am sure you will find a Python user and one of the most widely used Python packages. It is to Python what Rails group nearby. Another aspect of having a vibrant community is the large is to Ruby, if that means something number of libraries available. As of August 18, 2017, there are 114,910 pack- to you. More details at https://www. djangoproject.com. ages on the Python Package Index, the oicial repository for the Python You can find a calendar of upcoming language. This number does not include all the packages available on code Python events at https://www.python. hosting sites such as GitHub or Bitbucket. Finally, there are the 800,000+ org/events/. questions tagged with “Python” on Stack Overflow and the countless num- matlab® has about 74,000 questions on ber of articles, books, and blog posts about Python. Stack Overflow right now. Curiosity: Finally, you might just be curious. There is nothing wrong with that. © Enthought, Inc. Accelerate your Python migration with Enthought’s Python for Scientists and Engineers training course! https://www.enthought.com/training/course/python-for-scientists-and-engineers matlab®to python: a migration guide 8 Getting Started The most straightforward way to start using Python, especially for nu- merical computing, is to install the free Enthought Canopy application.
Recommended publications
  • Sagemath and Sagemathcloud
    Viviane Pons Ma^ıtrede conf´erence,Universit´eParis-Sud Orsay viviane.pons@lri.fr { @PyViv SageMath and SageMathCloud Introduction SageMath SageMath is a free open source mathematics software I Created in 2005 by William Stein. I http://www.sagemath.org/ I Mission: Creating a viable free open source alternative to Magma, Maple, Mathematica and Matlab. Viviane Pons (U-PSud) SageMath and SageMathCloud October 19, 2016 2 / 7 SageMath Source and language I the main language of Sage is python (but there are many other source languages: cython, C, C++, fortran) I the source is distributed under the GPL licence. Viviane Pons (U-PSud) SageMath and SageMathCloud October 19, 2016 3 / 7 SageMath Sage and libraries One of the original purpose of Sage was to put together the many existent open source mathematics software programs: Atlas, GAP, GMP, Linbox, Maxima, MPFR, PARI/GP, NetworkX, NTL, Numpy/Scipy, Singular, Symmetrica,... Sage is all-inclusive: it installs all those libraries and gives you a common python-based interface to work on them. On top of it is the python / cython Sage library it-self. Viviane Pons (U-PSud) SageMath and SageMathCloud October 19, 2016 4 / 7 SageMath Sage and libraries I You can use a library explicitly: sage: n = gap(20062006) sage: type(n) <c l a s s 'sage. interfaces .gap.GapElement'> sage: n.Factors() [ 2, 17, 59, 73, 137 ] I But also, many of Sage computation are done through those libraries without necessarily telling you: sage: G = PermutationGroup([[(1,2,3),(4,5)],[(3,4)]]) sage : G . g a p () Group( [ (3,4), (1,2,3)(4,5) ] ) Viviane Pons (U-PSud) SageMath and SageMathCloud October 19, 2016 5 / 7 SageMath Development model Development model I Sage is developed by researchers for researchers: the original philosophy is to develop what you need for your research and share it with the community.
    [Show full text]
  • A Comparative Evaluation of Matlab, Octave, R, and Julia on Maya 1 Introduction
    A Comparative Evaluation of Matlab, Octave, R, and Julia on Maya Sai K. Popuri and Matthias K. Gobbert* Department of Mathematics and Statistics, University of Maryland, Baltimore County *Corresponding author: gobbert@umbc.edu, www.umbc.edu/~gobbert Technical Report HPCF{2017{3, hpcf.umbc.edu > Publications Abstract Matlab is the most popular commercial package for numerical computations in mathematics, statistics, the sciences, engineering, and other fields. Octave is a freely available software used for numerical computing. R is a popular open source freely available software often used for statistical analysis and computing. Julia is a recent open source freely available high-level programming language with a sophisticated com- piler for high-performance numerical and statistical computing. They are all available to download on the Linux, Windows, and Mac OS X operating systems. We investigate whether the three freely available software are viable alternatives to Matlab for uses in research and teaching. We compare the results on part of the equipment of the cluster maya in the UMBC High Performance Computing Facility. The equipment has 72 nodes, each with two Intel E5-2650v2 Ivy Bridge (2.6 GHz, 20 MB cache) proces- sors with 8 cores per CPU, for a total of 16 cores per node. All nodes have 64 GB of main memory and are connected by a quad-data rate InfiniBand interconnect. The tests focused on usability lead us to conclude that Octave is the most compatible with Matlab, since it uses the same syntax and has the native capability of running m-files. R was hampered by somewhat different syntax or function names and some missing functions.
    [Show full text]
  • Armadillo C++ Library
    Armadillo: a template-based C++ library for linear algebra Conrad Sanderson and Ryan Curtin Abstract The C++ language is often used for implementing functionality that is performance and/or resource sensitive. While the standard C++ library provides many useful algorithms (such as sorting), in its current form it does not provide direct handling of linear algebra (matrix maths). Armadillo is an open source linear algebra library for the C++ language, aiming towards a good balance between speed and ease of use. Its high-level application programming interface (function syntax) is deliberately similar to the widely used Matlab and Octave languages [4], so that mathematical operations can be expressed in a familiar and natural manner. The library is useful for algorithm development directly in C++, or relatively quick conversion of research code into production environments. Armadillo provides efficient objects for vectors, matrices and cubes (third order tensors), as well as over 200 associated functions for manipulating data stored in the objects. Integer, floating point and complex numbers are supported, as well as dense and sparse storage formats. Various matrix factorisations are provided through integration with LAPACK [3], or one of its high performance drop-in replacements such as Intel MKL [6] or OpenBLAS [9]. It is also possible to use Armadillo in conjunction with NVBLAS to obtain GPU-accelerated matrix multiplication [7]. Armadillo is used as a base for other open source projects, such as MLPACK, a C++ library for machine learning and pattern recognition [2], and RcppArmadillo, a bridge between the R language and C++ in order to speed up computations [5].
    [Show full text]
  • A Fast Dynamic Language for Technical Computing
    Julia A Fast Dynamic Language for Technical Computing Created by: Jeff Bezanson, Stefan Karpinski, Viral B. Shah & Alan Edelman A Fractured Community Technical work gets done in many different languages ‣ C, C++, R, Matlab, Python, Java, Perl, Fortran, ... Different optimal choices for different tasks ‣ statistics ➞ R ‣ linear algebra ➞ Matlab ‣ string processing ➞ Perl ‣ general programming ➞ Python, Java ‣ performance, control ➞ C, C++, Fortran Larger projects commonly use a mixture of 2, 3, 4, ... One Language We are not trying to replace any of these ‣ C, C++, R, Matlab, Python, Java, Perl, Fortran, ... What we are trying to do: ‣ allow developing complete technical projects in a single language without sacrificing productivity or performance This does not mean not using components in other languages! ‣ Julia uses C, C++ and Fortran libraries extensively “Because We Are Greedy.” “We want a language that’s open source, with a liberal license. We want the speed of C with the dynamism of Ruby. We want a language that’s homoiconic, with true macros like Lisp, but with obvious, familiar mathematical notation like Matlab. We want something as usable for general programming as Python, as easy for statistics as R, as natural for string processing as Perl, as powerful for linear algebra as Matlab, as good at gluing programs together as the shell. Something that is dirt simple to learn, yet keeps the most serious hackers happy.” Collapsing Dichotomies Many of these are just a matter of design and focus ‣ stats vs. linear algebra vs. strings vs.
    [Show full text]
  • Data Visualization in Python
    Data visualization in python Day 2 A variety of packages and philosophies • (today) matplotlib: http://matplotlib.org/ – Gallery: http://matplotlib.org/gallery.html – Frequently used commands: http://matplotlib.org/api/pyplot_summary.html • Seaborn: http://stanford.edu/~mwaskom/software/seaborn/ • ggplot: – R version: http://docs.ggplot2.org/current/ – Python port: http://ggplot.yhathq.com/ • Bokeh (live plots in your browser) – http://bokeh.pydata.org/en/latest/ Biocomputing Bootcamp 2017 Matplotlib • Gallery: http://matplotlib.org/gallery.html • Top commands: http://matplotlib.org/api/pyplot_summary.html • Provides "pylab" API, a mimic of matlab • Many different graph types and options, some obscure Biocomputing Bootcamp 2017 Matplotlib • Resulting plots represented by python objects, from entire figure down to individual points/lines. • Large API allows any aspect to be tweaked • Lengthy coding sometimes required to make a plot "just so" Biocomputing Bootcamp 2017 Seaborn • https://stanford.edu/~mwaskom/software/seaborn/ • Implements more complex plot types – Joint points, clustergrams, fitted linear models • Uses matplotlib "under the hood" Biocomputing Bootcamp 2017 Others • ggplot: – (Original) R version: http://docs.ggplot2.org/current/ – A recent python port: http://ggplot.yhathq.com/ – Elegant syntax for compactly specifying plots – but, they can be hard to tweak – We'll discuss this on the R side tomorrow, both the basics of both work similarly. • Bokeh – Live, clickable plots in your browser! – http://bokeh.pydata.org/en/latest/
    [Show full text]
  • Scala Tutorial
    Scala Tutorial SCALA TUTORIAL Simply Easy Learning by tutorialspoint.com tutorialspoint.com i ABOUT THE TUTORIAL Scala Tutorial Scala is a modern multi-paradigm programming language designed to express common programming patterns in a concise, elegant, and type-safe way. Scala has been created by Martin Odersky and he released the first version in 2003. Scala smoothly integrates features of object-oriented and functional languages. This tutorial gives a great understanding on Scala. Audience This tutorial has been prepared for the beginners to help them understand programming Language Scala in simple and easy steps. After completing this tutorial, you will find yourself at a moderate level of expertise in using Scala from where you can take yourself to next levels. Prerequisites Scala Programming is based on Java, so if you are aware of Java syntax, then it's pretty easy to learn Scala. Further if you do not have expertise in Java but you know any other programming language like C, C++ or Python, then it will also help in grasping Scala concepts very quickly. Copyright & Disclaimer Notice All the content and graphics on this tutorial are the property of tutorialspoint.com. Any content from tutorialspoint.com or this tutorial may not be redistributed or reproduced in any way, shape, or form without the written permission of tutorialspoint.com. Failure to do so is a violation of copyright laws. This tutorial may contain inaccuracies or errors and tutorialspoint provides no guarantee regarding the accuracy of the site or its contents including this tutorial. If you discover that the tutorialspoint.com site or this tutorial content contains some errors, please contact us at webmaster@tutorialspoint.com TUTORIALS POINT Simply Easy Learning Table of Content Scala Tutorial ..........................................................................
    [Show full text]
  • Introduction to GNU Octave
    Introduction to GNU Octave Hubert Selhofer, revised by Marcel Oliver updated to current Octave version by Thomas L. Scofield 2008/08/16 line 1 1 0.8 0.6 0.4 0.2 0 -0.2 -0.4 8 6 4 2 -8 -6 0 -4 -2 -2 0 -4 2 4 -6 6 8 -8 Contents 1 Basics 2 1.1 What is Octave? ........................... 2 1.2 Help! . 2 1.3 Input conventions . 3 1.4 Variables and standard operations . 3 2 Vector and matrix operations 4 2.1 Vectors . 4 2.2 Matrices . 4 1 2.3 Basic matrix arithmetic . 5 2.4 Element-wise operations . 5 2.5 Indexing and slicing . 6 2.6 Solving linear systems of equations . 7 2.7 Inverses, decompositions, eigenvalues . 7 2.8 Testing for zero elements . 8 3 Control structures 8 3.1 Functions . 8 3.2 Global variables . 9 3.3 Loops . 9 3.4 Branching . 9 3.5 Functions of functions . 10 3.6 Efficiency considerations . 10 3.7 Input and output . 11 4 Graphics 11 4.1 2D graphics . 11 4.2 3D graphics: . 12 4.3 Commands for 2D and 3D graphics . 13 5 Exercises 13 5.1 Linear algebra . 13 5.2 Timing . 14 5.3 Stability functions of BDF-integrators . 14 5.4 3D plot . 15 5.5 Hilbert matrix . 15 5.6 Least square fit of a straight line . 16 5.7 Trapezoidal rule . 16 1 Basics 1.1 What is Octave? Octave is an interactive programming language specifically suited for vectoriz- able numerical calculations.
    [Show full text]
  • Xcode Package from App Store
    KH Computational Physics- 2016 Introduction Setting up your computing environment Installation • MAC or Linux are the preferred operating system in this course on scientific computing. • Windows can be used, but the most important programs must be installed – python : There is a nice package ”Enthought Python Distribution” http://www.enthought.com/products/edudownload.php – C++ and Fortran compiler – BLAS&LAPACK for linear algebra – plotting program such as gnuplot Kristjan Haule, 2016 –1– KH Computational Physics- 2016 Introduction Software for this course: Essentials: • Python, and its packages in particular numpy, scipy, matplotlib • C++ compiler such as gcc • Text editor for coding (for example Emacs, Aquamacs, Enthought’s IDLE) • make to execute makefiles Highly Recommended: • Fortran compiler, such as gfortran or intel fortran • BLAS& LAPACK library for linear algebra (most likely provided by vendor) • open mp enabled fortran and C++ compiler Useful: • gnuplot for fast plotting. • gsl (Gnu scientific library) for implementation of various scientific algorithms. Kristjan Haule, 2016 –2– KH Computational Physics- 2016 Introduction Installation on MAC • Install Xcode package from App Store. • Install ‘‘Command Line Tools’’ from Apple’s software site. For Mavericks and lafter, open Xcode program, and choose from the menu Xcode -> Open Developer Tool -> More Developer Tools... You will be linked to the Apple page that allows you to access downloads for Xcode. You wil have to register as a developer (free). Search for the Xcode Command Line Tools in the search box in the upper left. Download and install the correct version of the Command Line Tools, for example for OS ”El Capitan” and Xcode 7.2, Kristjan Haule, 2016 –3– KH Computational Physics- 2016 Introduction you need Command Line Tools OS X 10.11 for Xcode 7.2 Apple’s Xcode contains many libraries and compilers for Mac systems.
    [Show full text]
  • How to Access Python for Doing Scientific Computing
    How to access Python for doing scientific computing1 Hans Petter Langtangen1,2 1Center for Biomedical Computing, Simula Research Laboratory 2Department of Informatics, University of Oslo Mar 23, 2015 A comprehensive eco system for scientific computing with Python used to be quite a challenge to install on a computer, especially for newcomers. This problem is more or less solved today. There are several options for getting easy access to Python and the most important packages for scientific computations, so the biggest issue for a newcomer is to make a proper choice. An overview of the possibilities together with my own recommendations appears next. Contents 1 Required software2 2 Installing software on your laptop: Mac OS X and Windows3 3 Anaconda and Spyder4 3.1 Spyder on Mac............................4 3.2 Installation of additional packages.................5 3.3 Installing SciTools on Mac......................5 3.4 Installing SciTools on Windows...................5 4 VMWare Fusion virtual machine5 4.1 Installing Ubuntu...........................6 4.2 Installing software on Ubuntu....................7 4.3 File sharing..............................7 5 Dual boot on Windows8 6 Vagrant virtual machine9 1The material in this document is taken from a chapter in the book A Primer on Scientific Programming with Python, 4th edition, by the same author, published by Springer, 2014. 7 How to write and run a Python program9 7.1 The need for a text editor......................9 7.2 Spyder................................. 10 7.3 Text editors.............................. 10 7.4 Terminal windows.......................... 11 7.5 Using a plain text editor and a terminal window......... 12 8 The SageMathCloud and Wakari web services 12 8.1 Basic intro to SageMathCloud...................
    [Show full text]
  • Cmsc 132: Object-Oriented Programming Ii
    © Department of Computer Science UMD CMSC 132: OBJECT-ORIENTED PROGRAMMING II Iterator, Marker, Observer Design Patterns Department of Computer Science University of Maryland, College Park © Department of Computer Science UMD Design Patterns • Descriptions of reusable solutions to common software design problems (e.g, Iterator pattern) • Captures the experience of experts • Goals • Solve common programming challenges • Improve reliability of solution • Aid rapid software development • Useful for real-world applications • Design patterns are like recipes – generic solutions to expected situations • Design patterns are language independent • Recognizing when and where to use design patterns requires familiarity & experience • Design pattern libraries serve as a glossary of idioms for understanding common, but complex solutions • Design patterns are used throughout the Java Class Libraries © Department of Computer Science UMD Iterator Pattern • Definition • Move through collection of objects without knowing its internal representation • Where to use & benefits • Use a standard interface to represent data objects • Uses standard iterator built in each standard collection, like List • Need to distinguish variations in the traversal of an aggregate • Example • Iterator for collection • Original • Examine elements of collection directly • Using pattern • Collection provides Iterator class for examining elements in collection © Department of Computer Science UMD Iterator Example public interface Iterator<V> { bool hasNext(); V next(); void remove();
    [Show full text]
  • Iterators in C++ C 2016 All Rights Reserved
    Software Design Lecture Notes Prof. Stewart Weiss Iterators in C++ c 2016 All rights reserved. Iterators in C++ 1 Introduction When a program needs to visit all of the elements of a vector named myvec starting with the rst and ending with the last, you could use an iterative loop such as the following: for ( int i = 0; i < myvec.size(); i++ ) // the visit, i.e., do something with myvec[i] This code works and is a perfectly ne solution. This same type of iterative loop can visit each character in a C++ string. But what if you need code that visits all elements of a C++ list object? Is there a way to use an iterative loop to do this? To be clear, an iterative loop is one that has the form for var = start value; var compared to end value; update var; {do something with node at specic index} In other words, an iterative loop is a counting loop, as opposed to one that tests an arbitrary condition, like a while loop. The short answer to the question is that, in C++, without iterators, you cannot do this. Iterators make it possible to iterate through arbitrary containers. This set of notes answers the question, What is an iterator, and how do you use it? Iterators are a generalization of pointers in C++ and have similar semantics. They allow a program to navigate through dierent types of containers in a uniform manner. Just as pointers can be used to traverse a linked list or a binary tree, and subscripts can be used to traverse the elements of a vector, iterators can be used to sequence through the elements of any standard C++ container class.
    [Show full text]
  • Ginga Documentation Release 2.5.20160420043855
    Ginga Documentation Release 2.5.20160420043855 Eric Jeschke May 05, 2016 Contents 1 About Ginga 1 2 Copyright and License 3 3 Requirements and Supported Platforms5 4 Getting the source 7 5 Building and Installation 9 5.1 Detailed Installation Instructions for Ginga...............................9 6 Documentation 15 6.1 What’s New in Ginga?.......................................... 15 6.2 Ginga Quick Reference......................................... 19 6.3 The Ginga FAQ.............................................. 22 6.4 The Ginga Viewer and Toolkit Manual................................. 25 6.5 Reference/API.............................................. 87 7 Bug reports 107 8 Developer Info 109 9 Etymology 111 10 Pronunciation 113 11 Indices and tables 115 Python Module Index 117 i ii CHAPTER 1 About Ginga Ginga is a toolkit designed for building viewers for scientific image data in Python, visualizing 2D pixel data in numpy arrays. It can view astronomical data such as contained in files based on the FITS (Flexible Image Transport System) file format. It is written and is maintained by software engineers at the Subaru Telescope, National Astronomical Observatory of Japan. The Ginga toolkit centers around an image display class which supports zooming and panning, color and intensity mapping, a choice of several automatic cut levels algorithms and canvases for plotting scalable geometric forms. In addition to this widget, a general purpose “reference” FITS viewer is provided, based on a plugin framework. A fairly complete set of “standard” plugins are provided for features that we expect from a modern FITS viewer: panning and zooming windows, star catalog access, cuts, star pick/fwhm, thumbnails, etc. 1 Ginga Documentation, Release 2.5.20160420043855 2 Chapter 1.
    [Show full text]