diff --git a/README.rst b/README.rst index e3f566b..5fc0018 100644 --- a/README.rst +++ b/README.rst @@ -1,22 +1,28 @@ +====== DXfile -###### +====== .. image:: https://readthedocs.org/projects/dxfile/badge/?version=latest :target: https://readthedocs.org/projects/dxfile/?badge=latest :alt: Read the Docs -.. image:: https://anaconda.org/decarlof/dxfile/badges/version.svg - :target: https://anaconda.org/decarlof/dxfile +.. image:: https://anaconda.org/dgursoy/dxfile/badges/version.svg + :target: https://anaconda.org/dgursoy/dxfile :alt: Anaconda version -.. image:: https://anaconda.org/decarlof/dxfile/badges/downloads.svg - :target: https://anaconda.org/decarlof/dxfile +.. image:: https://anaconda.org/dgursoy/dxfile/badges/downloads.svg + :target: https://anaconda.org/dgursoy/dxfile :alt: Anaconda downloads -**DXfile** provides: +Features +-------- +* The definition of the scientific data exchange. +* A python interface for writing scientific data exchange files. +* XML attribute files for writers with the EPICS Area Detector HDF plug-in. - - The definition of the scientific data exchange. - - A python interface for writing scientific data exchange files. - - XML attribute files for writing scientific data exchange file with the EPICS Area Detector HDF plug in. +Contribute +---------- -Project Home Page: http://dxfile.readthedocs.org/ +* Documentation: https://github.com/data-exchange/dxfile/tree/master/doc +* Issue Tracker: https://github.com/data-exchange/dxfile/issues +* Source Code: https://github.com/data-exchange/dxfile \ No newline at end of file diff --git a/VERSION b/VERSION index d15723f..bd73f47 100644 --- a/VERSION +++ b/VERSION @@ -1 +1 @@ -0.3.2 +0.4 diff --git a/doc/index.rst b/doc/index.rst index 315767d..b07e64a 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,21 +1,49 @@ -.. title:: DXfile +====== +DXfile +====== -======= -Welcome -======= +Scientific Data Exchange :cite:`DeCarlo:14b` is a set of guidelines for storing +scientific data and metadata in a Hierarchical Data Format 5 :cite:`HDF:01` file. -This is the Data Exchange file format :cite:`DeCarlo:14b` web site, `DXfile `_ for short. The DXfile web site provides: - - The definition of the scientific data exchange - - A python interface for writing scientific data exchange files - - XML attribute files for writing scientific data exchange file with the EPICS Area Detector HDF plug in +HDF5 :cite:`HDF:01` has many important characteristics for scientific data +storage. It offers platform-independent binary data storage with optional +compression, hierarchical data ordering, and support for MPI-based +parallel computing. Data are stored with alphanumeric tags, so that one +can examine a HDF5 file’s contents with no knowledge of how the file +writing program was coded. Tools for this examination include the +HDF5-supplied command-line utility :cite:`HDF:02` to examine the contents +of any HDF5 file, or the freely-available Java program :cite:`HDF:03` +to interactively examine the file. -This guide is maintained on -`GitHub `_. +At synchrotron facilities using the EPICS :cite:`EPICS:01` software for area +detectors :cite:`AD:01` with the NDFileHDF5 plugin :cite:`AD:02`, is possible +to save Data Exchange files by properly configure the detector and the HDF +schema attribute files . + +This reference guide describes the basic design principles of Data +Exchange, examples of their application, a core reference for guidelines +common to most uses, and coding examples. + + +Features +-------- +* The definition of the scientific data exchange. +* A python interface for writing scientific data exchange files. +* XML attribute files for writers with the EPICS Area Detector HDF plug-in. + +Contribute +---------- + +* Documentation: https://github.com/data-exchange/dxfile/tree/master/doc +* Issue Tracker: https://github.com/data-exchange/dxfile/issues +* Source Code: https://github.com/data-exchange/dxfile + +Contents +-------- .. toctree:: :maxdepth: 1 - source/about source/introduction source/reference source/xraytomo diff --git a/doc/source/about.rst b/doc/source/about.rst deleted file mode 100644 index adff1f4..0000000 --- a/doc/source/about.rst +++ /dev/null @@ -1,7 +0,0 @@ -===== About ===== Welcome to the Data Exchange file format web site, DXfile for short. The DXfile web site provides: - The definition of the scientific data exchange - A python interface for writing scientific data exchange files - XML attribute files for writing scientific data exchange file with the EPICS Area Detector HDF plug in Data Exchange :cite:`DeCarlo:14b` is a set of guidelines for storing scientific data and metadata in a Hierarchical Data Format 5 :cite:`HDF:01` file. The design guidelines for Data Exchange provide a starting point to which one may add custom data and metadata to solve particular problems. HDF5 :cite:`HDF:01` has many important characteristics for scientific data storage. It offers platform-independent binary data storage with optional compression, hierarchical data ordering, and support for MPI-based parallel computing. Data are stored with alphanumeric tags, so that one can examine a HDF5 file’s contents with no knowledge of how the file writing program was coded. Tools for this examination include the HDF5-supplied command-line utility :cite:`HDF:02` to examine the contents -of any HDF5 file, or the freely-available Java program :cite:`HDF:03` to interactively examine the file. - -At synchrotron facilities using the EPICS :cite:`EPICS:01` software for area detectors :cite:`AD:01` with the -NDFileHDF5 plugin :cite:`AD:02`, is possible to save Data Exchange files by properly configure -the detector and the HDF schema attribute files . - This reference guide describes the basic design principles of Data Exchange, examples of their application, a core reference for guidelines common to most uses, and coding examples. diff --git a/doc/source/credits.rst b/doc/source/credits.rst index ce91af8..b542e94 100644 --- a/doc/source/credits.rst +++ b/doc/source/credits.rst @@ -1,7 +1 @@ -======= -Credits -======= - -We kindly request that you cite the following article :cite:`DeCarlo:14b` if you use DXfile. .. bibliography:: bibtex/cite.bib :style: plain :labelprefix: A - -References ========== .. bibliography:: bibtex/ref.bib :style: plain :labelprefix: B :all: +======= Credits ======= Citation ======== We kindly request that you cite the following article :cite:`DeCarlo:14b` if you use DXfile. .. bibliography:: bibtex/cite.bib :style: plain :labelprefix: A References ========== .. bibliography:: bibtex/ref.bib :style: plain :labelprefix: B :all: \ No newline at end of file diff --git a/doc/source/xraytomo.rst b/doc/source/xraytomo.rst index 07bf4b2..dacffe4 100644 --- a/doc/source/xraytomo.rst +++ b/doc/source/xraytomo.rst @@ -1,6 +1,5 @@ .. role:: math(raw) :format: html latex -.. ================ X-ray Tomography diff --git a/meta.yaml b/meta.yaml index 22c68a0..fad8b72 100644 --- a/meta.yaml +++ b/meta.yaml @@ -1,6 +1,6 @@ package: name: dxfile - version: '0.3.2' + version: '0.4' source: git_url: https://github.com/data-exchange/dxfile.git diff --git a/requirements.txt b/requirements.txt index ef36add..85f301c 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1 +1,2 @@ +sphinx sphinxcontrib-bibtex diff --git a/setup.py b/setup.py index ab03b0b..a1a230f 100644 --- a/setup.py +++ b/setup.py @@ -1,5 +1,6 @@ #!/usr/bin/env python # -*- coding: utf-8 -*- + from setuptools import setup, find_packages setup( @@ -8,6 +9,15 @@ packages=find_packages(), version=open('VERSION').read().strip(), description = 'Reader/Writer for Data Exchange files.', - license='BSD', - platforms='Any' + license='BSD-3', + platforms='Any', + classifiers=[ + 'Development Status :: 4 - Beta', + 'Intended Audience :: Science/Research', + 'License :: BSD-3', + 'Natural Language :: English', + 'Programming Language :: Python :: 2.7', + 'Programming Language :: Python :: 3.4', + 'Programming Language :: Python :: 3.5', + ] )