Fix package docstrings, #1612

This commit is contained in:
Adam J. Stewart 2016-08-24 10:32:29 -05:00
parent 0614bd206f
commit eb56744f4d
31 changed files with 83 additions and 128 deletions

View file

@ -27,12 +27,10 @@
class Adios(Package):
"""
The Adaptable IO System (ADIOS) provides a simple,
"""The Adaptable IO System (ADIOS) provides a simple,
flexible way for scientists to describe the
data in their code that may need to be written,
read, or processed outside of the running simulation
"""
read, or processed outside of the running simulation."""
homepage = "http://www.olcf.ornl.gov/center-projects/adios/"
url = "https://github.com/ornladios/ADIOS/archive/v1.10.0.tar.gz"

View file

@ -26,6 +26,11 @@
class Antlr(Package):
"""ANTLR (ANother Tool for Language Recognition) is a powerful parser
generator for reading, processing, executing, or translating structured
text or binary files. It's widely used to build languages, tools, and
frameworks. From a grammar, ANTLR generates a parser that can build and
walk parse trees."""
homepage = "http://www.antlr.org"
url = "https://github.com/antlr/antlr/tarball/v2.7.7"

View file

@ -26,8 +26,7 @@
class ArpackNg(Package):
"""
ARPACK-NG is a collection of Fortran77 subroutines designed to solve large
"""ARPACK-NG is a collection of Fortran77 subroutines designed to solve large
scale eigenvalue problems.
Important Features:
@ -51,8 +50,8 @@ class ArpackNg(Package):
forked it and implemented their own modifications, arpack-ng aims to tackle
this by providing a common repository and maintained versions.
arpack-ng is replacing arpack almost everywhere.
"""
arpack-ng is replacing arpack almost everywhere."""
homepage = 'https://github.com/opencollab/arpack-ng'
url = 'https://github.com/opencollab/arpack-ng/archive/3.3.0.tar.gz'

View file

@ -26,8 +26,9 @@
class Asciidoc(Package):
""" A presentable text document format for writing articles, UNIX man
"""A presentable text document format for writing articles, UNIX man
pages and other small to medium sized documents."""
homepage = "http://asciidoc.org"
url = "http://downloads.sourceforge.net/project/asciidoc/asciidoc/8.6.9/asciidoc-8.6.9.tar.gz"

View file

@ -26,10 +26,9 @@
class Astyle(Package):
"""
A Free, Fast, and Small Automatic Formatter for C, C++, C++/CLI,
Objective-C, C#, and Java Source Code.
"""
"""A Free, Fast, and Small Automatic Formatter for C, C++, C++/CLI,
Objective-C, C#, and Java Source Code."""
homepage = "http://astyle.sourceforge.net/"
url = "http://downloads.sourceforge.net/project/astyle/astyle/astyle%202.04/astyle_2.04_linux.tar.gz"

View file

@ -26,11 +26,9 @@
class Caliper(Package):
"""
Caliper is a generic context annotation system. It gives programmers the
"""Caliper is a generic context annotation system. It gives programmers the
ability to provide arbitrary program context information to (performance)
tools at runtime.
"""
tools at runtime."""
homepage = "https://github.com/LLNL/Caliper"
url = ""

View file

@ -26,11 +26,11 @@
class Cfitsio(Package):
"""
CFITSIO is a library of C and Fortran subroutines for reading and writing
data files in FITS (Flexible Image Transport System) data format.
"""
"""CFITSIO is a library of C and Fortran subroutines for reading and writing
data files in FITS (Flexible Image Transport System) data format."""
homepage = 'http://heasarc.gsfc.nasa.gov/fitsio/'
version('3.370', 'abebd2d02ba5b0503c633581e3bfa116')
def url_for_version(self, v):

View file

@ -27,6 +27,8 @@
class Cityhash(Package):
"""CityHash, a family of hash functions for strings."""
homepage = "https://github.com/google/cityhash"
url = "https://github.com/google/cityhash"

View file

@ -22,18 +22,15 @@
# License along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
##############################################################################
from spack import *
class Cube(Package):
"""
Cube the profile viewer for Score-P and Scalasca profiles. It displays a
"""Cube the profile viewer for Score-P and Scalasca profiles. It displays a
multi-dimensional performance space consisting of the dimensions:
- performance metric
- call path
- system resource
"""
- system resource"""
homepage = "http://www.scalasca.org/software/cube-4.x/download.html"
url = "http://apps.fz-juelich.de/scalasca/releases/cube/4.2/dist/cube-4.2.3.tar.gz"

View file

@ -26,10 +26,8 @@
class Datamash(Package):
"""
GNU datamash is a command-line program which performs basic numeric,
textual and statistical operations on input textual data files.
"""
"""GNU datamash is a command-line program which performs basic numeric,
textual and statistical operations on input textual data files."""
homepage = "https://www.gnu.org/software/datamash/"
url = "http://ftp.gnu.org/gnu/datamash/datamash-1.0.5.tar.gz"

View file

@ -26,11 +26,8 @@
class Eigen(Package):
"""
Eigen is a C++ template library for linear algebra
Matrices, vectors, numerical solvers, and related algorithms
"""
"""Eigen is a C++ template library for linear algebra matrices,
vectors, numerical solvers, and related algorithms."""
homepage = 'http://eigen.tuxfamily.org/'
url = 'http://bitbucket.org/eigen/eigen/get/3.2.7.tar.bz2'

View file

@ -23,17 +23,15 @@
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
##############################################################################
from spack import *
import os
class Espresso(Package):
"""
QE is an integrated suite of Open-Source computer codes for
"""QE is an integrated suite of Open-Source computer codes for
electronic-structure calculations and materials modeling at
the nanoscale. It is based on density-functional theory, plane
waves, and pseudopotentials.
"""
waves, and pseudopotentials."""
homepage = 'http://quantum-espresso.org'
url = 'http://www.qe-forge.org/gf/download/frsrelease/204/912/espresso-5.3.0.tar.gz'

View file

@ -26,15 +26,13 @@
class Gdal(Package):
"""
GDAL is a translator library for raster and vector geospatial
"""GDAL is a translator library for raster and vector geospatial
data formats that is released under an X/MIT style Open Source
license by the Open Source Geospatial Foundation. As a library,
it presents a single raster abstract data model and vector
abstract data model to the calling application for all supported
formats. It also comes with a variety of useful command line
utilities for data translation and processing
"""
utilities for data translation and processing"""
homepage = "http://www.gdal.org/"
url = "http://download.osgeo.org/gdal/2.0.2/gdal-2.0.2.tar.gz"

View file

@ -22,16 +22,14 @@
# License along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
##############################################################################
from spack import *
class Gdb(Package):
"""GDB, the GNU Project debugger, allows you to see what is going on
`inside' another program while it executes -- or what another
program was doing at the moment it crashed.
'inside' another program while it executes -- or what another
program was doing at the moment it crashed."""
"""
homepage = "https://www.gnu.org/software/gdb"
url = "http://ftp.gnu.org/gnu/gdb/gdb-7.10.tar.gz"

View file

@ -26,15 +26,14 @@
class Gmsh(Package):
"""
Gmsh is a free 3D finite element grid generator with a built-in CAD engine
"""Gmsh is a free 3D finite element grid generator with a built-in CAD engine
and post-processor. Its design goal is to provide a fast, light and
user-friendly meshing tool with parametric input and advanced visualization
capabilities. Gmsh is built around four modules: geometry, mesh, solver and
post-processing. The specification of any input to these modules is done
either interactively using the graphical user interface or in ASCII text
files using Gmsh's own scripting language.
"""
files using Gmsh's own scripting language."""
homepage = 'http://gmsh.info'
url = 'http://gmsh.info/src/gmsh-2.11.0-source.tgz'

View file

@ -27,14 +27,13 @@
class Lmod(Package):
"""
Lmod is a Lua based module system that easily handles the MODULEPATH
"""Lmod is a Lua based module system that easily handles the MODULEPATH
Hierarchical problem. Environment Modules provide a convenient way to
dynamically change the users' environment through modulefiles. This
includes easily adding or removing directories to the PATH environment
variable. Modulefiles for Library packages provide environment variables
that specify where the library and header files can be found.
"""
that specify where the library and header files can be found."""
homepage = 'https://www.tacc.utexas.edu/research-development/tacc-projects/lmod'
url = 'https://github.com/TACC/Lmod/archive/6.4.1.tar.gz'

View file

@ -26,15 +26,14 @@
class LuaLuafilesystem(Package):
"""
LuaFileSystem is a Lua library developed to complement the set of
"""LuaFileSystem is a Lua library developed to complement the set of
functions related to file systems offered by the standard Lua distribution.
LuaFileSystem offers a portable way to access the underlying directory
structure and file attributes.
LuaFileSystem is free software and uses the same license as Lua 5.1
"""
LuaFileSystem is free software and uses the same license as Lua 5.1"""
homepage = 'http://keplerproject.github.io/luafilesystem'
url = 'https://github.com/keplerproject/luafilesystem/archive/v_1_6_3.tar.gz'

View file

@ -26,11 +26,9 @@
class Mxml(Package):
"""
Mini-XML is a small XML library that you can use to read and write XML
"""Mini-XML is a small XML library that you can use to read and write XML
and XML-like data files in your application without requiring large
non-standard libraries
"""
non-standard libraries."""
homepage = "http://www.msweet.org"
url = "http://www.msweet.org/files/project3/mxml-2.9.tar.gz"

View file

@ -26,13 +26,11 @@
class Ncdu(Package):
"""
Ncdu is a disk usage analyzer with an ncurses interface. It is designed
"""Ncdu is a disk usage analyzer with an ncurses interface. It is designed
to find space hogs on a remote server where you don't have an entire
gaphical setup available, but it is a useful tool even on regular desktop
systems. Ncdu aims to be fast, simple and easy to use, and should be able
to run in any minimal POSIX-like environment with ncurses installed.
"""
to run in any minimal POSIX-like environment with ncurses installed."""
homepage = "http://dev.yorhel.nl/ncdu"
url = "http://dev.yorhel.nl/download/ncdu-1.11.tar.gz"

View file

@ -22,21 +22,18 @@
# License along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
##############################################################################
from spack import *
class Opari2(Package):
"""
OPARI2 is a source-to-source instrumentation tool for OpenMP and hybrid
"""OPARI2 is a source-to-source instrumentation tool for OpenMP and hybrid
codes. It surrounds OpenMP directives and runtime library calls with calls
to the POMP2 measurement interface. OPARI2 will provide you with a new
initialization method that allows for multi-directory and parallel builds
as well as the usage of pre-instrumented libraries. Furthermore, an
efficient way of tracking parent-child relationships was added.
Additionally, we extended OPARI2 to support instrumentation of OpenMP 3.0
tied tasks.
"""
tied tasks."""
homepage = "http://www.vi-hps.org/projects/score-p"
url = "http://www.vi-hps.org/upload/packages/opari2/opari2-1.1.2.tar.gz"

View file

@ -26,14 +26,13 @@
class Openjpeg(Package):
"""
OpenJPEG is an open-source JPEG 2000 codec written in C language.
"""OpenJPEG is an open-source JPEG 2000 codec written in C language.
It has been developed in order to promote the use of JPEG 2000, a
still-image compression standard from the Joint Photographic
Experts Group (JPEG).
Since April 2015, it is officially recognized by ISO/IEC and
ITU-T as a JPEG 2000 Reference Software.
"""
ITU-T as a JPEG 2000 Reference Software."""
homepage = "https://github.com/uclouvain/openjpeg"
url = "https://github.com/uclouvain/openjpeg/archive/version.2.1.tar.gz"

View file

@ -26,11 +26,9 @@
class Parallel(Package):
"""
GNU parallel is a shell tool for executing jobs in parallel using
"""GNU parallel is a shell tool for executing jobs in parallel using
one or more computers. A job can be a single command or a small
script that has to be run for each of the lines in the input.
"""
script that has to be run for each of the lines in the input."""
homepage = "http://www.gnu.org/software/parallel/"
url = "http://ftp.gnu.org/gnu/parallel/parallel-20160422.tar.bz2"

View file

@ -27,11 +27,9 @@
class Petsc(Package):
"""
PETSc is a suite of data structures and routines for the scalable
"""PETSc is a suite of data structures and routines for the scalable
(parallel) solution of scientific applications modeled by partial
differential equations.
"""
differential equations."""
homepage = "http://www.mcs.anl.gov/petsc/index.html"
url = "http://ftp.mcs.anl.gov/pub/petsc/release-snapshots/petsc-3.5.3.tar.gz"

View file

@ -22,16 +22,14 @@
# License along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
##############################################################################
from spack import depends_on, extends, version
from spack import Package
from spack import *
class PyPrettytable(Package):
"""
PrettyTable is a simple Python library designed to make
"""PrettyTable is a simple Python library designed to make
it quick and easy to represent tabular data in visually
appealing ASCII tables
"""
appealing ASCII tables."""
homepage = "https://code.google.com/archive/p/prettytable/"
url = "https://pypi.python.org/packages/e0/a1/36203205f77ccf98f3c6cf17cf068c972e6458d7e58509ca66da949ca347/prettytable-0.7.2.tar.gz"

View file

@ -26,10 +26,9 @@
class PyTuiview(Package):
"""
TuiView is a lightweight raster GIS with powerful raster attribute
table manipulation abilities.
"""
"""TuiView is a lightweight raster GIS with powerful raster attribute
table manipulation abilities."""
homepage = "https://bitbucket.org/chchrsc/tuiview"
url = "https://bitbucket.org/chchrsc/tuiview/get/tuiview-1.1.7.tar.gz"

View file

@ -22,16 +22,13 @@
# License along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
##############################################################################
from spack import *
class Scorep(Package):
"""
The Score-P measurement infrastructure is a highly scalable and easy-to-use
tool suite for profiling, event tracing, and online analysis of HPC
applications.
"""
"""The Score-P measurement infrastructure is a highly scalable and
easy-to-use tool suite for profiling, event tracing, and online analysis
of HPC applications."""
homepage = "http://www.vi-hps.org/projects/score-p"
url = "http://www.vi-hps.org/upload/packages/scorep/scorep-1.2.3.tar.gz"

View file

@ -26,10 +26,8 @@
class Screen(Package):
"""
Screen is a full-screen window manager that multiplexes a physical
terminal between several processes, typically interactive shells.
"""
"""Screen is a full-screen window manager that multiplexes a physical
terminal between several processes, typically interactive shells."""
homepage = "https://www.gnu.org/software/screen/"
url = "http://ftp.gnu.org/gnu/screen/screen-4.3.1.tar.gz"

View file

@ -22,18 +22,14 @@
# License along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
##############################################################################
from spack import *
import llnl.util.tty as tty
class Swiftsim(Package):
"""
SPH With Inter-dependent Fine-grained Tasking (SWIFT) provides
"""SPH With Inter-dependent Fine-grained Tasking (SWIFT) provides
astrophysicists with a state of the art framework to perform
particle based simulations.
"""
particle based simulations."""
homepage = 'http://icc.dur.ac.uk/swift/'
url = 'http://gitlab.cosma.dur.ac.uk/swift/swiftsim/repository/archive.tar.gz?ref=v0.3.0'

View file

@ -22,21 +22,17 @@
# License along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
##############################################################################
from spack import *
import os
import os.path
from llnl.util.filesystem import join_path
class Tau(Package):
"""
A portable profiling and tracing toolkit for performance
"""A portable profiling and tracing toolkit for performance
analysis of parallel programs written in Fortran, C, C++, UPC,
Java, Python.
"""
Java, Python."""
homepage = "http://www.cs.uoregon.edu/research/tau"
url = "https://www.cs.uoregon.edu/research/tau/tau_releases/tau-2.25.tar.gz"

View file

@ -26,12 +26,11 @@
class XercesC(Package):
""" Xerces-C++ is a validating XML parser written in a portable subset of C++.
Xerces-C++ makes it easy to give your application the ability to read and
write XML data. A shared library is provided for parsing, generating,
"""Xerces-C++ is a validating XML parser written in a portable subset of
C++. Xerces-C++ makes it easy to give your application the ability to read
and write XML data. A shared library is provided for parsing, generating,
manipulating, and validating XML documents using the DOM, SAX, and SAX2
APIs.
"""
APIs."""
homepage = "https://xerces.apache.org/xerces-c"
url = "https://www.apache.org/dist/xerces/c/3/sources/xerces-c-3.1.4.tar.bz2"

View file

@ -26,11 +26,10 @@
class Zsh(Package):
"""
Zsh is a shell designed for interactive use, although it is also a powerful
scripting language. Many of the useful features of bash, ksh, and tcsh were
incorporated into zsh; many original features were added.
"""
"""Zsh is a shell designed for interactive use, although it is also a
powerful scripting language. Many of the useful features of bash, ksh, and
tcsh were incorporated into zsh; many original features were added."""
homepage = "http://www.zsh.org"
url = "http://downloads.sourceforge.net/project/zsh/zsh/5.1.1/zsh-5.1.1.tar.gz"