Metadata-Version: 1.1
Name: Stoner
Version: 0.1.0
Summary: Classes to represent simple scientific data sets and write analysis codes, developed for the University of Leeds Condensed Matter Physics Group
Home-page: http://github.com/~gb119/Stoner-PythonCode
Author: Gavin Burnell
Author-email: g.burnell@leeds.ac.uk
License: GPLv3
Description: Stoner-PythonCode
        =================
        
        Introduction
        ------------
        This is the  *Stoner* Python package for writing data analysis code. It was written within the Condensed Matter Physis 
        group at the University of Leeds as a shared resource for quickly writing simple programs to do things list fit functions
        to data, extract curve parameters and churn through large numbers of data files.
        
        For a general introduction, users are referered to the User Guide pdf file that can be found in the *doc* directory. 
        There is also an API reference in the form of a compiled help file in the *doc* directory that is generated from the
        Doxygen formatted comments in the source code.
         
        Overview
        -------- 
        The **Stoner** package provides two basic top-level classes that describe an individual file of experimental data and a 
        list (such as a directory on disc) of many experimental files. For our research, a typical single experimental data file
        is essentially a single 2D table of floating point numbers with associated metadata. This seems to cover most experiemnts
        in the physical sciences, but it you need a more complex format with more dimensions of data, we suggest you look elsewhere.
         
        **Stoner.Core.DataFile** is the base class for representing individual experimental data sets. 
        It provides basic methods to examine and manipulate data, manage metadata and load and save data files. 
        It has a large number of sub classes - most of these are in Stoner.FileFormats and are used to handle the loading of specific 
        file formats. Two, however, contain additional functionality for writing analysis programs.
         
        **Stoner.Analysis.AnalyseFile** provides additional methods for curve-fitting, differentiating, smoothing and carrying out 
        basic calculations on data. 
        
        **Stoner.Plot.PlotFile** provides additional routines for plotting data on 2D or 3D plots. As previosuly mentioned , there are 
        subclasses of **DataFile** in the **Stoner.FileFormats** module that support loading many of the common file formats used in 
        our research.
        
        **Stoner.Folders.DataFolder** is a class for assisting with the work of processing lots of files in a common directory 
        structure. It provides methods to list. filter and group data according to filename patterns or metadata and then to execute
        a function on each file or group of files.
        
        The **Stoner.HDF5** module provides some experimental classes to manipulate *DataFile* and *DataFolder* objects within HDF5
        format files. These are not a way to handle arbitary HDF5 files - the format is much to complex and flexible to make that
        an easy task, rather it is a way to work with large numbers of experimental sets using just a single file which may be less
        brutal to your computer's OS than having directory trees with millions of individual files.
        
         
        Resources
        ---------
         
        Included in the package are a (small) collection of sample scripts for carrying out various operations and some sample data 
        files for testing the loading and processing of data. Finally, this folder contains the LaTeX source code, dvi file and 
        pdf version of the User Guide and this compiled help file which has been gerneated by Doxygen from the contents of the 
        python docstrings in the source code. 
        
        Contact and Licensing
        ---------------------
        
        The lead developer for this code is Dr Gavin Burnell <g.burnell@leeds.ac.uk> http://www.stoner.leeds.ac.uk/people/gb. 
        The User Guide gives the current list of other contributors to the project.
        
        This code and the sample data are all (C) The University of Leeds 2008-2013 unless otherwise indicated in the source file. 
        The contents of this package are licensed under the terms of the GNU Public License v3
Keywords: Data-Analysis Physics
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Topic :: Scientific/Engineering
Classifier: Programming Language :: Python :: 2.7
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
