From d73621af726dfb346ec24741a4cd855698ee6ace Mon Sep 17 00:00:00 2001 From: davidovitch Date: Mon, 26 Oct 2015 20:20:34 +0100 Subject: [PATCH] [WIP] add first iteration and incomplete packaging files generated with pyscaffold --- AUTHORS.rst | 8 ++ CHANGES.rst | 11 +++ LICENSE.txt | 17 ++++ README.rst | 74 ++++++++++++++ docs/Makefile | 177 ++++++++++++++++++++++++++++++++++ docs/authors.rst | 2 + docs/changes.rst | 2 + docs/conf.py | 238 ++++++++++++++++++++++++++++++++++++++++++++++ docs/index.rst | 45 +++++++++ docs/license.rst | 7 ++ requirements.txt | 6 ++ setup.cfg | 87 +++++++++++++++++ setup.py | 68 +++++++++++++ tests/conftest.py | 12 +++ wafo/setup.py | 17 ++++ wafo/version.py | 4 + 16 files changed, 775 insertions(+) create mode 100644 AUTHORS.rst create mode 100644 CHANGES.rst create mode 100644 LICENSE.txt create mode 100644 README.rst create mode 100644 docs/Makefile create mode 100644 docs/authors.rst create mode 100644 docs/changes.rst create mode 100644 docs/conf.py create mode 100644 docs/index.rst create mode 100644 docs/license.rst create mode 100644 requirements.txt create mode 100644 setup.cfg create mode 100644 setup.py create mode 100644 tests/conftest.py create mode 100644 wafo/setup.py create mode 100644 wafo/version.py diff --git a/AUTHORS.rst b/AUTHORS.rst new file mode 100644 index 0000000..7d4e079 --- /dev/null +++ b/AUTHORS.rst @@ -0,0 +1,8 @@ +========== +Developers +========== + +* Per A. Brodtkorb +* Georg Lindgren +* David Verelst + diff --git a/CHANGES.rst b/CHANGES.rst new file mode 100644 index 0000000..31cafee --- /dev/null +++ b/CHANGES.rst @@ -0,0 +1,11 @@ +========= +Changelog +========= + +Version 0.1 +=========== + +- Feature A added +- FIX: nasty bug #1729 fixed +- add your changes here! + diff --git a/LICENSE.txt b/LICENSE.txt new file mode 100644 index 0000000..177d08e --- /dev/null +++ b/LICENSE.txt @@ -0,0 +1,17 @@ +WAFO is free software; you can redistribute it and/or modify it under the terms +of the GNU General Public License (GPL, http://www.gnu.org/copyleft/gpl.html) +as published by the Free Software Foundation; either version 3 of the License, +or (at your option) any later version. + +WAFO is distributed in the hope that it will be useful, but WITHOUT ANY +WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A +PARTICULAR PURPOSE. + +A small number of files (listed in COPYRIGHTS) are distributed under the +GNU LESSER GENERAL PUBLIC LICENSE (LGPL, http://www.gnu.org/licenses/lgpl.html); +either version 3 of the License, or (at your option) any later version. + +See the GNU General Public License for more details http://www.gnu.org/licenses/ + +We encourage you to submit new code for possible inclusion in future versions of +WAFO. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..7fcd8e3 --- /dev/null +++ b/README.rst @@ -0,0 +1,74 @@ +========================================== +Wave Analysis for Fatigue and Oceanography +========================================== + +Description +=========== + +WAFO is a toolbox Python routines for statistical analysis and simulation of +random waves and random loads. WAFO is freely redistributable software, see WAFO +icence, cf. the GNU General Public License (GPL) and contain tools for: + +Fatigue Analysis +---------------- +-Fatigue life prediction for random loads +-Theoretical density of rainflow cycles + +Sea modelling +------------- +-Simulation of linear and non-linear Gaussian waves +-Estimation of seamodels (spectrums) +-Joint wave height, wave steepness, wave period distributions + +Statistics +------------ +-Extreme value analysis +-Kernel density estimation +-Hidden markov models + +WAFO consists of several subpackages and classes with short descriptions given +below. + +Classes: +TimeSeries - Data analysis of time series. Example: extraction of + turning points, estimation of spectrum and covariance function. + Estimation transformation used in transformed Gaussian model. +CovData - Computation of spectral functions, linear + and non-linear time series simulation. +SpecData - Computation of spectral moments and covariance functions, linear + and non-linear time series simulation. + Ex: common spectra implemented, directional spectra, + bandwidth measures, exact distributions for wave characteristics. + +CyclePairs - Cycle counting, discretization, and crossings, calculation of + damage. Simulation of discrete Markov chains, switching Markov + chains, harmonic oscillator. Ex: Rainflow cycles and matrix, + discretization of loads. Damage of a rainflow count or + matrix, damage matrix, S-N plot. + + +Subpackages: +TRANSFORM - Modelling with linear or transformed Gaussian waves. Ex: +STATS - Statistical tools and extreme-value distributions. + Ex: generation of random numbers, estimation of parameters, + evaluation of pdf and cdf +KDETOOLS - Kernel-density estimation. +MISC - Miscellaneous routines. +DOCS - Documentation of toolbox, definitions. An overview is given + in the routine wafomenu. +DATA - Measurements from marine applications. + +WAFO homepage: +On the WAFO home page you will find: +- The WAFO Tutorial +- New versions of WAFO to download. +- Reported bugs. +- List of publications related to WAFO. + + +Note +==== + +This project has been set up using PyScaffold 2.4.2. For details and usage +information on PyScaffold see http://pyscaffold.readthedocs.org/. + diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 0000000..403c409 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,177 @@ +# Makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +PAPER = +BUILDDIR = _build + +# User-friendly check for sphinx-build +ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $?), 1) +$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/) +endif + +# Internal variables. +PAPEROPT_a4 = -D latex_paper_size=a4 +PAPEROPT_letter = -D latex_paper_size=letter +ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . +# the i18n builder cannot share the environment and doctrees with the others +I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . + +.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext + +help: + @echo "Please use \`make ' where is one of" + @echo " html to make standalone HTML files" + @echo " dirhtml to make HTML files named index.html in directories" + @echo " singlehtml to make a single large HTML file" + @echo " pickle to make pickle files" + @echo " json to make JSON files" + @echo " htmlhelp to make HTML files and a HTML help project" + @echo " qthelp to make HTML files and a qthelp project" + @echo " devhelp to make HTML files and a Devhelp project" + @echo " epub to make an epub" + @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" + @echo " latexpdf to make LaTeX files and run them through pdflatex" + @echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx" + @echo " text to make text files" + @echo " man to make manual pages" + @echo " texinfo to make Texinfo files" + @echo " info to make Texinfo files and run them through makeinfo" + @echo " gettext to make PO message catalogs" + @echo " changes to make an overview of all changed/added/deprecated items" + @echo " xml to make Docutils-native XML files" + @echo " pseudoxml to make pseudoxml-XML files for display purposes" + @echo " linkcheck to check all external links for integrity" + @echo " doctest to run all doctests embedded in the documentation (if enabled)" + +clean: + rm -rf $(BUILDDIR)/* + +html: + $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." + +dirhtml: + $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml + @echo + @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." + +singlehtml: + $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml + @echo + @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." + +pickle: + $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle + @echo + @echo "Build finished; now you can process the pickle files." + +json: + $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json + @echo + @echo "Build finished; now you can process the JSON files." + +htmlhelp: + $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp + @echo + @echo "Build finished; now you can run HTML Help Workshop with the" \ + ".hhp project file in $(BUILDDIR)/htmlhelp." + +qthelp: + $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp + @echo + @echo "Build finished; now you can run "qcollectiongenerator" with the" \ + ".qhcp project file in $(BUILDDIR)/qthelp, like this:" + @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pywafo.qhcp" + @echo "To view the help file:" + @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pywafo.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/pywafo" + @echo "# ln -s $(BUILDDIR)/devhelp $HOME/.local/share/devhelp/pywafo" + @echo "# devhelp" + +epub: + $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub + @echo + @echo "Build finished. The epub file is in $(BUILDDIR)/epub." + +latex: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo + @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." + @echo "Run \`make' in that directory to run these through (pdf)latex" \ + "(use \`make latexpdf' here to do that automatically)." + +latexpdf: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through pdflatex..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +latexpdfja: + $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex + @echo "Running LaTeX files through platex and dvipdfmx..." + $(MAKE) -C $(BUILDDIR)/latex all-pdf-ja + @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." + +text: + $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text + @echo + @echo "Build finished. The text files are in $(BUILDDIR)/text." + +man: + $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man + @echo + @echo "Build finished. The manual pages are in $(BUILDDIR)/man." + +texinfo: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo + @echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo." + @echo "Run \`make' in that directory to run these through makeinfo" \ + "(use \`make info' here to do that automatically)." + +info: + $(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo + @echo "Running Texinfo files through makeinfo..." + make -C $(BUILDDIR)/texinfo info + @echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo." + +gettext: + $(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale + @echo + @echo "Build finished. The message catalogs are in $(BUILDDIR)/locale." + +changes: + $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes + @echo + @echo "The overview file is in $(BUILDDIR)/changes." + +linkcheck: + $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck + @echo + @echo "Link check complete; look for any errors in the above output " \ + "or in $(BUILDDIR)/linkcheck/output.txt." + +doctest: + $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest + @echo "Testing of doctests in the sources finished, look at the " \ + "results in $(BUILDDIR)/doctest/output.txt." + +xml: + $(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml + @echo + @echo "Build finished. The XML files are in $(BUILDDIR)/xml." + +pseudoxml: + $(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml + @echo + @echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml." diff --git a/docs/authors.rst b/docs/authors.rst new file mode 100644 index 0000000..cd8e091 --- /dev/null +++ b/docs/authors.rst @@ -0,0 +1,2 @@ +.. _authors: +.. include:: ../AUTHORS.rst diff --git a/docs/changes.rst b/docs/changes.rst new file mode 100644 index 0000000..257630a --- /dev/null +++ b/docs/changes.rst @@ -0,0 +1,2 @@ +.. _changes: +.. include:: ../CHANGES.rst diff --git a/docs/conf.py b/docs/conf.py new file mode 100644 index 0000000..96d72b6 --- /dev/null +++ b/docs/conf.py @@ -0,0 +1,238 @@ +# -*- coding: utf-8 -*- +# +# This file is execfile()d with the current directory set to its containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys +import os +import inspect +from sphinx import apidoc + + +__location__ = os.path.join(os.getcwd(), os.path.dirname( + inspect.getfile(inspect.currentframe()))) + +package = "wafo" +namespace = [] +namespace_pkg = ".".join([namespace[-1], package]) if namespace else package + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +# sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +# needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', + 'sphinx.ext.autosummary', 'sphinx.ext.viewcode', 'sphinx.ext.coverage', + 'sphinx.ext.doctest', 'sphinx.ext.ifconfig', 'sphinx.ext.pngmath'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +# source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'pywafo' +copyright = u'2015, davidovitch' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = '' # Is set by calling `setup.py docs` +# The full version, including alpha/beta/rc tags. +release = '' # Is set by calling `setup.py docs` + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +# today = '' +# Else, today_fmt is used as the format for a strftime call. +# today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = ['_build'] + +# The reST default role (used for this markup: `text`) to use for all documents. +# default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +# add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +# add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +# show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# A list of ignored prefixes for module index sorting. +# modindex_common_prefix = [] + +# If true, keep warnings as "system message" paragraphs in the built documents. +# keep_warnings = False + + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'alabaster' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +# html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +# html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +try: + from namespace_pkg import __version__ as version +except ImportError: + pass +else: + release = version + +# A shorter title for the navigation bar. Default is the same as html_title. +# html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +# html_logo = "" + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +# html_favicon = None + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +# html_last_updated_fmt = '%b %d, %Y' + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +# html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +# html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +# html_additional_pages = {} + +# If false, no module index is generated. +# html_domain_indices = True + +# If false, no index is generated. +# html_use_index = True + +# If true, the index is split into individual pages for each letter. +# html_split_index = False + +# If true, links to the reST sources are added to the pages. +# html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +# html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +# html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +# html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +# html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'wafo-doc' + + +# -- Options for LaTeX output -------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +# 'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +# 'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +# 'preamble': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'user_guide.tex', u'pywafo Documentation', + u'davidovitch', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +# latex_logo = "" + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +# latex_use_parts = False + +# If true, show page references after internal links. +# latex_show_pagerefs = False + +# If true, show URL addresses after external links. +# latex_show_urls = False + +# Documents to append as an appendix to all manuals. +# latex_appendices = [] + +# If false, no module index is generated. +# latex_domain_indices = True + +# -- External mapping ------------------------------------------------------------ +python_version = '.'.join(map(str, sys.version_info[0:2])) +intersphinx_mapping = { + 'sphinx': ('http://sphinx.pocoo.org', None), + 'python': ('http://docs.python.org/' + python_version, None), + 'matplotlib': ('http://matplotlib.sourceforge.net', None), + 'numpy': ('http://docs.scipy.org/doc/numpy', None), + 'sklearn': ('http://scikit-learn.org/stable', None), + 'pandas': ('http://pandas.pydata.org/pandas-docs/stable', None), + 'scipy': ('http://docs.scipy.org/doc/scipy/reference/', None), +} diff --git a/docs/index.rst b/docs/index.rst new file mode 100644 index 0000000..bfa570d --- /dev/null +++ b/docs/index.rst @@ -0,0 +1,45 @@ +====== +pywafo +====== + +This is the documentation of **pywafo**. + +.. note:: + + This is the main page of your project's `Sphinx `_ + documentation. It is formatted in `reStructuredText + `__. Add additional pages by creating + rst-files in ``docs`` and adding them to the `toctree + `_ below. Use then + `references `__ in order to link + them from this page, e.g. :ref:`authors ` and :ref:`changes`. + It is also possible to refer to the documentation of other Python packages + with the `Python domain syntax + `__. By default you + can reference the documentation of `Sphinx `__, + `Python `__, `matplotlib + `__, `NumPy + `__, `Scikit-Learn + `__, `Pandas + `__, `SciPy + `__. You can add more by + extending the ``intersphinx_mapping`` in your Sphinx's ``conf.py``. + +Contents +======== + +.. toctree:: + :maxdepth: 2 + + License + Authors + Changelog + Module Reference + + +Indices and tables +================== + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` diff --git a/docs/license.rst b/docs/license.rst new file mode 100644 index 0000000..6437528 --- /dev/null +++ b/docs/license.rst @@ -0,0 +1,7 @@ +.. _license: + +======= +License +======= + +.. literalinclude:: ../LICENSE.txt diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..260dceb --- /dev/null +++ b/requirements.txt @@ -0,0 +1,6 @@ +# Add your requirements here like: +six +numpy>=1.4 +numdifftools>=0.2 +scipy>=0.9 + diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..2e9eabf --- /dev/null +++ b/setup.cfg @@ -0,0 +1,87 @@ +[metadata] +name = wafo +summary = Wave Analysis for Fatigue and Oceanography +author = WAFO-group +author-email = none +license = GPLv3 +home-page = http://www.maths.lth.se/matstat/wafo/ +description-file = README.rst +# Add here all kinds of additional classifiers as defined under +# https://pypi.python.org/pypi?%3Aaction=list_classifiers +classifiers = Development Status :: 4 - Beta, + Programming Language :: Python, + Programming Language :: Python :: 2.7, + Programming Language :: Python :: 3, + Programming Language :: Python :: 3.3, + Programming Language :: Python :: 3.4, + Environment :: Console, + Intended Audience :: Education, + Intended Audience :: Science/Research, + License :: OSI Approved :: GPL License, + Operating System :: OS Independent, + Operating System :: POSIX :: Linux, + Operating System :: Unix, + Operating System :: MacOS, + Operating System :: Microsoft :: Windows + Topic :: Scientific/Engineering :: Mathematics + +[entry_points] +# Add here console scripts like: +# console_scripts = +# hello_world = wafo.module:function +# as well as other entry_points. + + +[files] +# Add here 'data_files', 'packages' or 'namespace_packages'. +# Additional data files are defined as key value pairs of source and target: +packages = + wafo +# data_files = +# share/wafo_docs = docs/* + +[extras] +# Add here additional requirements for extra features, like: +# PDF = +# ReportLab>=1.2 +# RXP + +[test] +# py.test options when running `python setup.py test` +addopts = tests + +[pytest] +# Options for py.test: +# Specify command line options as you would do when invoking py.test directly. +# e.g. --cov-report html (or xml) for html/xml output or --junitxml junit.xml +# in order to write a coverage file that can be read by Jenkins. +addopts = + --cov wafo --cov-report term-missing + --verbose + +[aliases] +docs = build_sphinx + +[bdist_wheel] +# Use this option if your package is pure-python +universal = 0 + +[build_sphinx] +source_dir = docs +build_dir = docs/_build + +[pbr] +# Let pbr run sphinx-apidoc +autodoc_tree_index_modules = True +# autodoc_tree_excludes = ... +# Let pbr itself generate the apidoc +# autodoc_index_modules = True +# autodoc_exclude_modules = ... +# Convert warnings to errors +# warnerrors = True + +[devpi:upload] +# Options for the devpi: PyPI serer and packaging tool +# VCS export must be deactivated since we are using setuptools-scm +no-vcs = 1 +format = bdist_wheel diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..c268ba4 --- /dev/null +++ b/setup.py @@ -0,0 +1,68 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +""" + Setup file for wafo. + + This file was generated with PyScaffold 2.4.2, a tool that easily + puts up a scaffold for your new Python project. Learn more under: + http://pyscaffold.readthedocs.org/ +""" + +from __future__ import division, absolute_import, print_function + +# numpy.distutils will figure out if setuptools is available when imported +# this allows us to combine setuptools use_pyscaffold=True and f2py extensions +import setuptools +from numpy.distutils.core import setup, Extension + +import sys + + +def setup_package_pyscaffold(): + + extensions = [] + + c_lib_ext = Extension('wafo.c_library', + sources=['wafo/source/c_library/c_library.pyf', + 'wafo/source/c_library/c_functions.c']) + extensions.append(c_lib_ext) + +# rind_ext = Extension('wafo.rindmod', +# extra_objects=['wafo/source/rind2007/intmodule.f', +# 'wafo/source/rind2007/jacobmod.f', +# 'wafo/source/rind2007/swapmod.f', +# 'wafo/source/rind2007/fimod.f', +# 'wafo/source/rind2007/rindmod.f', +# 'wafo/source/rind2007/rind71mod.f'], +# sources=['wafo/source/rind2007/rind_interface.f']) +# extensions.append(rind_ext) +# +# mreg_ext = Extension('wafo.cov2mod', +# sources=['wafo/source/mreg/dsvdc.f', +# 'wafo/source/mreg/mregmodule.f', +# 'wafo/source/mreg/intfcmod.f', +# 'wafo/source/mreg/cov2mmpdfreg_intfc.f'], +# include_dirs=['wafo/source/rind2007']) +# extensions.append(mreg_ext) + + mvn_ext = Extension('wafo.mvn', + sources=['wafo/source/mvn/mvn.pyf', + 'wafo/source/mvn/mvndst.f']) + extensions.append(mvn_ext) + +# mvnprd_ext = Extension('wafo.mvnprdmod', +# sources=['wafo/source/mvnprd/mvnprd.f', +# 'wafo/source/mvnprd/mvnprodcorrprb.f', +# 'wafo/source/mvnprd/mvnprd_interface.f']) +# extensions.append(mvnprd_ext) + + + needs_sphinx = {'build_sphinx', 'upload_docs'}.intersection(sys.argv) + sphinx = ['sphinx'] if needs_sphinx else [] + setup(setup_requires=['six', 'pyscaffold>=2.4rc1,<2.5a0'] + sphinx, + tests_require=['pytest_cov', 'pytest'], + use_pyscaffold=True, + ext_modules=extensions) + +if __name__ == "__main__": + setup_package_pyscaffold() diff --git a/tests/conftest.py b/tests/conftest.py new file mode 100644 index 0000000..356cf9c --- /dev/null +++ b/tests/conftest.py @@ -0,0 +1,12 @@ +#!/usr/bin/env python +# -*- coding: utf-8 -*- +""" + Dummy conftest.py for wafo. + + If you don't know what this is for, just leave it empty. + Read more about conftest.py under: + https://pytest.org/latest/plugins.html +""" +from __future__ import print_function, absolute_import, division + +import pytest diff --git a/wafo/setup.py b/wafo/setup.py new file mode 100644 index 0000000..e0a51bb --- /dev/null +++ b/wafo/setup.py @@ -0,0 +1,17 @@ +# -*- coding: utf-8 -*- +""" +Created on Sun Oct 25 14:55:34 2015 + +@author: dave +""" + +def configuration(parent_package='', top_path=None): + from numpy.distutils.misc_util import Configuration + config = Configuration('wafo', parent_package, top_path) + config.add_subpackage('source') + config.make_config_py() + return config + +if __name__ == "__main__": + from numpy.distutils.core import setup + setup(**configuration(top_path='').todict()) diff --git a/wafo/version.py b/wafo/version.py new file mode 100644 index 0000000..b6a96c7 --- /dev/null +++ b/wafo/version.py @@ -0,0 +1,4 @@ +# THIS FILE IS GENERATED FROM SETUP.PY +short_version='0.1.2' +version='0.1.2' +release=False