Skip to content

Commit

Permalink
Move to pydsd (josephhardinee#57)
Browse files Browse the repository at this point in the history
This Commit squashes many individual commits. Among them:

* Minor bugfixes to plotting
* Updated setup.py and moved top level source directory to pydsd
* Updated README, and setup.py
* Updated Test Cases
* Updating documentation to refer to pydsd
* Updating examples to use pydsd instead of pydisdrometer
* Fixed a failing test in Image2DReader that pointed to pydisdrometer still
* Fixed travis script to point to pydsd
* Added ARM Vdis reader
* Updates to versioneer setup
* Updated manifest to include description. Apparently versioneer remved it?
* setup.py inlined description. Not sure what is causing this break
* Updated README to add Nick in
* Added fit to installer
* Fixed a bug introduced by a change in numpy 1.13. pcolormesh no longer accepts masked arrays as coordinates arguments
* Added a make clean to docs to ensure old files are not used
* Updated docs to point to pydsd as well now
* Fixed one of the examples that had a fixed path
* Fixed an example. Still need to find a better test file for it
  • Loading branch information
josephhardinee authored Dec 3, 2017
1 parent 1179e98 commit bbe824b
Show file tree
Hide file tree
Showing 65 changed files with 245 additions and 96 deletions.
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
pydisdrometer/_version.py export-subst
pydsd/_version.py export-subst
10 changes: 5 additions & 5 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,27 +13,27 @@ matrix:
- python: '2.7'
env:
- PYTHON_VERSION="2.7"
- NOSE_ARGS="-v --no-skip --with-cov --cov pydisdrometer pydisdrometer"
- NOSE_ARGS="-v --no-skip --with-cov --cov pydsd pydsd"
- COVERALLS="true"
- python: '3.4'
env:
- PYTHON_VERSION="3.4"
- NOSE_ARGS="-v --no-skip --with-cov --cov pydisdrometer pydisdrometer"
- NOSE_ARGS="-v --no-skip --with-cov --cov pydsd pydsd"
- COVERALLS="true"
- python: '3.5'
env:
- PYTHON_VERSION="3.5"
- NOSE_ARGS="-v --no-skip --with-cov --cov pydisdrometer pydisdrometer"
- NOSE_ARGS="-v --no-skip --with-cov --cov pydsd pydsd"
- COVERALLS="true"
- python: '3.6'
env:
- PYTHON_VERSION="3.6"
- NOSE_ARGS="-v --no-skip --with-cov --cov pydisdrometer pydisdrometer"
- NOSE_ARGS="-v --no-skip --with-cov --cov pydsd pydsd"
- COVERALLS="true"
- python: '3.6'
env:
- PYTHON_VERSION="3.6"
- NOSE_ARGS="-v --no-skip --with-cov --cov pydisdrometer pydisdrometer"
- NOSE_ARGS="-v --no-skip --with-cov --cov pydsd pydsd"
- COVERALLS="true"
- DOC_BUILD="true"
before_install:
Expand Down
5 changes: 3 additions & 2 deletions MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
include pydisdrometer/utility/metadata.json
include pydsd/utility/metadata.json
include versioneer.py
include pydisdrometer/_version.py
include pydsd/_version.py
include description.txt
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# PyDisdrometer
# PyDSD

[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.9991.svg)](https://doi.org/10.5281/zenodo.9991)

[![Coverage Status](https://coveralls.io/repos/github/josephhardinee/PyDisdrometer/badge.svg?branch=master)](https://coveralls.io/github/josephhardinee/PyDisdrometer?branch=master)
[![Coverage Status](https://coveralls.io/repos/github/josephhardinee/PyDSD/badge.svg?branch=master)](https://coveralls.io/github/josephhardinee/PyDSD?branch=master)

PyDisdrometer is a Python package to process disdrometer files. It currently is capable of reading several different types of disdrometer formats, with more being added regularly. It currently supports the following functionality:
PyDSD is a Python package to process disdrometer files. It currently is capable of reading several different types of disdrometer formats, with more being added regularly. It currently supports the following functionality:
1) File Reading
2) Microphysics Estimation
3) T-Matrix Scattering of Radar Parameters
4) QPE Relationship Estimation.

It currently supports OTT Parsivel disdrometers, Joss Waldvogel Disdrometers, 2DVD files, and HVPS and 2DS airborne disdrometers.

Author: Joseph C. Hardin
Author: Joseph C. Hardin, Nick Guy

## Usage

Expand All @@ -36,13 +36,13 @@ The scattered fields will be stored in the fields dictionary of the dsd object.
plot(dsd.time, dsd.fields['Zh']['data'])
```

For more information, please see the examples in the Notebooks directory. Additionally you can find some initial documentation at [PyDisdrometer Documentation](http://josephhardinee.github.io/PyDisdrometer)
For more information, please see the examples in the Notebooks directory. Additionally you can find some initial documentation at [PyDSD Documentation](http://josephhardinee.github.io/PyDSD)

Requirements:
This library currently requires the normal scientific python stack(numpy+scipy+matplotlib)
It also requires the [PyTMatrix Package](https://github.com/jleinonen/pytmatrix).

We welcome contributions from all users. Please see the examples in Notebooks for a more indepth guide on how to use PyDisdrometer.
We welcome contributions from all users. Please see the examples in Notebooks for a more indepth guide on how to use PyDSD.

## User Group
There is now a pydisdrometer user group mailing list at
Expand Down
3 changes: 2 additions & 1 deletion continuous_integration/build_docs.sh
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
set -e
pip install doctr pillow
cd docs
make clean
make html
cd ..
doctr deploy .
doctr deploy .
8 changes: 4 additions & 4 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -85,17 +85,17 @@ qthelp:
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PyDisdrometer.qhcp"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/PyDSD.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PyDisdrometer.qhc"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/PyDSD.qhc"

devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/PyDisdrometer"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PyDisdrometer"
@echo "# mkdir -p $$HOME/.local/share/devhelp/PyDSD"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/PyDSD"
@echo "# devhelp"

epub:
Expand Down
24 changes: 12 additions & 12 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
#
# PyDisdrometer documentation build configuration file, created by
# PyDSD documentation build configuration file, created by
# sphinx-quickstart on Tue Jul 29 15:22:22 2014.
#
# This file is execfile()d with the current directory set to its
Expand Down Expand Up @@ -59,7 +59,7 @@
master_doc = 'index'

# General information about the project.
project = u'PyDisdrometer'
project = u'PyDSD'
copyright = u'2014, Joseph C. Hardin'

# The version info for the project you're documenting, acts as replacement for
Expand Down Expand Up @@ -192,7 +192,7 @@
#html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = 'PyDisdrometerdoc'
htmlhelp_basename = 'PyDSDdoc'


# -- Options for LaTeX output ---------------------------------------------
Expand All @@ -212,7 +212,7 @@
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
('index', 'PyDisdrometer.tex', u'PyDisdrometer Documentation',
('index', 'PyDSD.tex', u'PyDSD Documentation',
u'Joseph C. Hardin', 'manual'),
]

Expand Down Expand Up @@ -242,7 +242,7 @@
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'pydisdrometer', u'PyDisdrometer Documentation',
('index', 'pydsd', u'PyDSD Documentation',
[u'Joseph C. Hardin'], 1)
]

Expand All @@ -256,8 +256,8 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'PyDisdrometer', u'PyDisdrometer Documentation',
u'Joseph C. Hardin', 'PyDisdrometer', 'One line description of project.',
('index', 'PyDSD', u'PyDSD Documentation',
u'Joseph C. Hardin', 'PyDSD', 'One line description of project.',
'Miscellaneous'),
]

Expand All @@ -277,13 +277,13 @@
# -- Options for Epub output ----------------------------------------------

# Bibliographic Dublin Core info.
epub_title = u'PyDisdrometer'
epub_author = u'Joseph C. Hardin'
epub_publisher = u'Joseph C. Hardin'
epub_copyright = u'2014, Joseph C. Hardin'
epub_title = u'PyDSD'
epub_author = u'Joseph C. Hardin, Nick Guy'
epub_publisher = u'Joseph C. Hardin, Nick Guy'
epub_copyright = u'2014, Joseph C. Hardin, Nick Guy'

# The basename for the epub file. It defaults to the project name.
#epub_basename = u'PyDisdrometer'
#epub_basename = u'PyDSD'

# The HTML theme for the epub output. Since the default themes are not optimized
# for small screen space, using the same theme for HTML and epub output is
Expand Down
10 changes: 5 additions & 5 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
.. PyDisdrometer documentation master file, created by
.. PyDSD documentation master file, created by
sphinx-quickstart on Tue Jul 29 15:22:22 2014.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
Welcome to PyDisdrometer's documentation!
Welcome to PyDSD's documentation!
=========================================

Contents:
Expand All @@ -13,9 +13,9 @@ Contents:

source/auto_examples/index

pydisdrometer.rst
pydisdrometer.aux_readers.rst
pydisdrometer.plot.rst
pydsd.rst
pydsd.aux_readers.rst
pydsd.plot.rst

Indices and tables
==================
Expand Down
Original file line number Diff line number Diff line change
@@ -1,27 +1,27 @@
:mod:`pydisdrometer.aux_readers`
:mod:`pydsd.aux_readers`
=================================


Module contents
---------------

.. automodule:: pydisdrometer.aux_readers
.. automodule:: pydsd.aux_readers
:members:
:undoc-members:
:show-inheritance:

:mod:`GPMApuWallopsRawReader`
--------------------------------------------------------

.. automodule:: pydisdrometer.aux_readers.GPMApuWallopsRawReader
.. automodule:: pydsd.aux_readers.GPMApuWallopsRawReader
:members:
:undoc-members:
:show-inheritance:

:mod:`NASA_2DVD_reader`
-------------------------------------------------

.. automodule:: pydisdrometer.aux_readers.NASA_2DVD_reader
.. automodule:: pydsd.aux_readers.NASA_2DVD_reader
:members:
:undoc-members:
:show-inheritance:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@ This module contains plotting functions for the `DropSizeDistribution` object.
Module contents
---------------

.. automodule:: pydisdrometer.plot
.. automodule:: pydsd.plot
:members:
:undoc-members:
:show-inheritance:

:mod:`dsd_plots`
--------------------------------------------------------
.. automodule:: pydisdrometer.plot.plot
.. automodule:: pydsd.plot.plot
:members:
:undoc-members:
:show-inheritance:
Expand Down
22 changes: 11 additions & 11 deletions docs/source/pydisdrometer.rst → docs/source/pydsd.rst
Original file line number Diff line number Diff line change
@@ -1,69 +1,69 @@
pydisdrometer package
pydsd package
=====================

Subpackages
-----------

.. toctree::

pydisdrometer.aux_readers
pydisdrometer.plot
pydsd.aux_readers
pydsd.plot

Submodules
----------

DSDProcessor module
---------------------------------

.. automodule:: pydisdrometer.DSDProcessor
.. automodule:: pydsd.DSDProcessor
:members:
:undoc-members:
:show-inheritance:

DSR module
------------------------

.. automodule:: pydisdrometer.DSR
.. automodule:: pydsd.DSR
:members:
:undoc-members:
:show-inheritance:

DropSizeDistribution module
-----------------------------------------

.. automodule:: pydisdrometer.DropSizeDistribution
.. automodule:: pydsd.DropSizeDistribution
:members:
:undoc-members:
:show-inheritance:

JWDReader module
------------------------------

.. automodule:: pydisdrometer.io.JWDReader
.. automodule:: pydsd.io.JWDReader
:members:
:undoc-members:
:show-inheritance:

ParsivelNasaGVReader module
-----------------------------------------

.. automodule:: pydisdrometer.io.ParsivelNasaGVReader
.. automodule:: pydsd.io.ParsivelNasaGVReader
:members:
:undoc-members:
:show-inheritance:

ParsivelReader module
-----------------------------------

.. automodule:: pydisdrometer.io.ParsivelReader
.. automodule:: pydsd.io.ParsivelReader
:members:
:undoc-members:
:show-inheritance:

expfit module
--------------------------

.. automodule:: pydisdrometer.utility.expfit
.. automodule:: pydsd.utility.expfit
:members:
:undoc-members:
:show-inheritance:
Expand All @@ -72,7 +72,7 @@ expfit module
Module contents
---------------

.. automodule:: pydisdrometer
.. automodule:: pydsd
:members:
:undoc-members:
:show-inheritance:
4 changes: 2 additions & 2 deletions examples/README.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
PyDisdrometer Example Gallery
PyDSD Example Gallery
-----------------------------

PyDisdrometer Example Gallery.
PyDSD Example Gallery.
4 changes: 2 additions & 2 deletions examples/plot_basic_example.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@
Simple Example
--------------
A simple example using PyDisdrometer. This example reads in a OTT APU Disdrometer file, calculates the radar variables, and plots a few of them.
A simple example using PyDSD. This example reads in a OTT APU Disdrometer file, calculates the radar variables, and plots a few of them.
Author: Joseph C. Hardin
"""

import numpy as np
import matplotlib.pyplot as plt

import pydisdrometer as pyd
import pydsd as pyd


filename = '../testdata/sgpdisdrometerC1.b1.20110427.000000_test_jwd_b1.cdf'
Expand Down
Loading

0 comments on commit bbe824b

Please sign in to comment.