Merge pull request #19 from BaPSF/1.0.0

Merge `v1.0.0` into `Master`

.gitignore

@@ -11,11 +11,12 @@
 /docs/_build/
 
 # PyCharm specifics
-/.idea/workspace.xml
+.idea/*
+# /.idea/workspace.xml
 
 # macOS Files
 .DS_Store
 
 # venv
-/venv/
-
+venv/
+build/

.travis.yml

@@ -16,6 +16,14 @@ language: python
 python:
   - "3.5"
   - "3.6"
+# Enable 3.7 without globally enabling sudo and dist: xenial for other
+# build jobs
+# workaround https://github.com/travis-ci/travis-ci/issues/9815
+matrix:
+  include:
+    - python: "3.7"
+      dist: xenial
+      sudo: true
 
 # install dependencies
 install:

LICENSES/LICENSE.txt

@@ -1,7 +1,7 @@
-BSD 3-Clause License for bapsflib Project version 0.1.2
-=======================================================
+BSD 3-Clause License for the bapsflib Project
+=============================================
 
-Copyright (c) 2017, Erik T. Everson and contributors
+Copyright (c) 2017-2018, Erik T. Everson and contributors
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

LICENSES/license_astropy.txt

@@ -0,0 +1,26 @@
+Copyright (c) 2011-2017, Astropy Developers
+
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice, this
+  list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+* Neither the name of the Astropy Team nor the names of its contributors may be
+  used to endorse or promote products derived from this software without
+  specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

MANIFEST.in

@@ -1,8 +1,9 @@
 include README.md
-include MANIFEST.in
-include *.txt
+include requirements.txt
+# include MANIFEST.in
+# include *.txt
 
 recursive-include docs *
-prune docs/_build
+recursive-include LICENSES *
 
-recursive-include licenses *
+prune docs/_build

README.md

@@ -1,26 +1,41 @@
 # bapsflib
 
-[![GitHub package version](https://img.shields.io/badge/version-v1.0.0.dev-blue.svg)](./bapsflib/__init__.py)
+[![PyPI](https://img.shields.io/pypi/v/bapsflib.svg)](https://pypi.org/project/bapsflib)
 [![License](https://img.shields.io/badge/License-BSD-blue.svg)](./LICENSES/LICENSE.txt)
 
 [![Documentation Status](https://readthedocs.org/projects/bapsflib/badge/)](https://bapsflib.readthedocs.io/en/latest)
-[![Build Status](https://travis-ci.org/BaPSF/bapsflib.svg?branch=master)](https://travis-ci.org/BaPSF/bapsflib)
+[![Build Status](https://img.shields.io/travis/BaPSF/bapsflib/master.svg?label=Travis%20CI)](https://travis-ci.org/BaPSF/bapsflib)
 [![codecov](https://codecov.io/gh/BaPSF/bapsflib/branch/master/graph/badge.svg)](https://codecov.io/gh/BaPSF/bapsflib/branch/master)
 
+[![h5py](https://img.shields.io/badge/powered%20by-h5py-%235e9ffa.svg)](https://www.h5py.org/)
+
 The **bapsflib** package is developed on Python 3.5+ and is intend to 
 be a toolkit for reading, manipulating, and analyzing data collected at 
-the Basic Plasma Science Facility (BaPSF). The current development 
-focus is to build a high-level, structured interface between the user 
-and the HDF5 files generated by the Large Plasma Device (LaPD).
+the Basic Plasma Science Facility 
+([BaPSF](http://plasma.physics.ucla.edu/)) at UCLA. 
+
+The current development cycle is focused on providing a high-level, 
+structured interface between the user and the HDF5 files generated from
+experiments on the Large Plasma Device (LaPD).  This interface 
+leverages [h5py](https://www.h5py.org/).
 
 ## Installation
 
-Since **bapsflib** is in its early development, it has not been 
-registered with [PyPI](https://pypi.org/) yet.  Installation 
-instructions can be found in the Installation section of the 
-[documentation](https://bapsflib.readthedocs.io/).
+**bapsflib** is registered with [PyPI](https://pypi.org/) and can be 
+installed with `pip` via
+
+`pip install bapsflib`
+
+To install from source look to installation instructions in 
+documentation, 
+[here](https://bapsflib.readthedocs.io/en/latest/installation.html).
 
 ## Documentation
 
 The documentation is hosted on Read the Docs at 
-https://bapsflib.readthedocs.io/
+https://bapsflib.readthedocs.io/en/latest
+
+## License
+
+**bapsflib** is licensed under a 3-clause BSD license, see 
+[LICENSE.txt](LICENSES/LICENSE.txt).

bapsflib/__init__.py

@@ -26,4 +26,4 @@
 from . import plasma
 
 # --- Define version ---------------------------------------------------
-__version__ = '1.0.0.dev'
+__version__ = '1.0.0'

bapsflib/_hdf/maps/controls/tests/fauxsixk.py

@@ -12,6 +12,7 @@
 import random
 import math
 import numpy as np
+import platform
 
 from datetime import datetime as dt
 from warnings import warn
@@ -291,7 +292,10 @@ def _add_motionlist_groups(self):
             self.create_group(ml_gname)
 
             # set motionlist attributes
-            timestamp = dt.now().strftime('%-m/%-d/%Y %-I:%M:%S %p')
+            time_format = '%-m/%-d/%Y %-I:%M:%S %p'
+            if platform.system() == 'Windows':
+                time_format = time_format.replace('-', '#')
+            timestamp = dt.now().strftime(time_format)
             self[ml_gname].attrs.update({
                 'Created date': np.bytes_(timestamp),
                 'Data motion count': np.uint32(sn_size_for_ml[i]),

bapsflib/_hdf/utils/hdfoverview.py

@@ -9,6 +9,7 @@
 #   license terms and contributor agreement.
 #
 import os
+import platform
 import pprint as pp
 
 from contextlib import redirect_stdout
@@ -47,11 +48,14 @@ def print(self):
         #
         from bapsflib import __version__
         # ------ Print Header                                     ------
+        time_format = '%-m/%-d/%Y %-I:%M:%S %p'
+        if platform.system() == 'Windows':
+            time_format = time_format.replace('-', '#')
         print('=' * 72)
         print('{} Overview'.format(self._file.info['file']))
         print('Generated by bapsflib (v' + __version__ + ')')
         print('Generated date: '
-              + datetime.now().strftime('%-m/%-d/%Y %-I:%M:%S %p'))
+              + datetime.now().strftime(time_format))
         print('=' * 72 + '\n\n')
 
         # ------ Print General Info                               ------