Metadata-Version: 2.1
Name: pyspedas
Version: 0.2.3
Summary: Package for SPEDAS data loading modules
Home-page: https://github.com/nickssl/pyspedas
Author: Nick Hatzigeorgiu
Author-email: nikos@berkeley.edu
License: MIT
Project-URL: Information, http://spedas.org/wiki/
Description: # pyspedas
        
        Load data from SPEDAS CDF files into pytplot. 
        
        Pyspedas is a python package that contains data loading modules for various scientific NASA missions. 
        
        The load routines are designed to work with the libraries cdflib, pytplot.
        
        
        ### How It Works
        
        CDF files are downloaded from the internet to the local machine. Local data directory is specified in the file `spd_prefs_txt.py`. 
        
        
        ### Install Python
        
        You will need the Anaconda distribution of Python 3 in order to run pyspedas.  
        
        [Anaconda](https://www.continuum.io/downloads/) comes with a suite of packages that are useful for data science. 
        
        You should also install [git](<https://git-scm.com>) which makes installation of python packages easier.
        
        
        ### Install pyspedas
        
        To install pyspedas, use the command:
        
        `pip install git+https://github.com/nickssl/pyspedas`
        
        
        
        ### Running pyspedas
        
        After installation, please change the file `pyspedas\spd_prefs_txt.py` and set `data_dir=C:\Datapy\themis` to a directory of your choice. 
        
        To download CDF files for the Themis mission, use: 
        
        `pyspedas.load_data(mission, dates, probes, instruments, level, downloadonly)`
        
        Example: 
        
        `d = pyspedas.load_data('themis', '2015-12-31', ['tha'], '*', 'l2', False)`
        
        
        > **Parameters**:
        >  
        > - `mission = 'themis'`   the name of the mission, currently only 'themis' is available
        > - `dates = '2015-12-31'` list of dates to be downloaded	
        > - `probes = ['tha', 'tha']`  list of probes ['tha', 'tha', 'thc', 'thd', 'the'], wildcard ('*') for all probes 
        > - `instruments = ['fft']` list of instruments, wildcard ('*') for all instruments  
        > - `level = 'l2'`  either 'l2' or 'l1'
        > - `downloadonly = True` if True then CDF files are downloaded only, if False then they are also loaded into pytplot using pytplot.cdf_to_tplot
        
        
        List of possible values for L2 themis "instruments" variable:
        
        `['efi', 'esa', 'fbk', 'fft', 'fgm', 'fit', 'gmom', 'mom', 'scm', 'sst']`
        
        List of possible values for L1 themis "instruments" variable:
        
        `['bau', 'eff', 'efp', 'efw', 'esa', 'fbk', 'fff_16', 'fff_32', 'fff_64', 'ffp_16', 'ffp_32', 'ffp_64', 'ffw_16', 'ffw_32', 'ffw_64', 'fgm', 'fit', 'hsk', 'mom', 'scf', 'scm', 'scmode', 'scp', 'scw', 'spin', 'sst', 'state', 'trg', 'vaf', 'vap', 'vaw']`
        
        
        ### Additional Information
        
        For pytplot, see: https://github.com/MAVENSDC/PyTplot
        
        For cdflib, see: https://github.com/MAVENSDC/cdflib
        
        For SPEDAS, see http://spedas.org/blog/
        
        For information on the Themis mission, see http://themis.ssl.berkeley.edu/ 
        
        
Keywords: spedas data tools
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Scientific/Engineering
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3
Description-Content-Type: text/markdown
