-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #32 from prjemian/development
documentation
- Loading branch information
Showing
3 changed files
with
126 additions
and
125 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,72 +1,73 @@ | ||
| .. | ||
| This file describes user-visible changes between the versions. | ||
| Change History | ||
| ############## | ||
|
|
||
| Production | ||
| ********** | ||
|
|
||
| :2015.0113.0: dropped requirement of *lxml* package | ||
| :2014.1228.1: build mne:name cross-references for counters and positioners | ||
| :2014.1228.0: show version in documentation | ||
| :2014.1028.0: quietly ignore unrecognized scan content *for now* | ||
| :2014.1027.1: major changes in SPEC file support: **custom plugins** | ||
|
|
||
| * **spec** based on plugins for each control line, users can add plugins | ||
| * declared **prjPySpec** module as legacy, code is frozen at *2014.0623.0* release | ||
| * added **spec** module to replace **prjPySpec** | ||
|
|
||
| :2014.0623.0: updated argparse settings | ||
| :2014.0622.2: added extractSpecScan.py to the suite from the USAXS project | ||
| :2014.0410.0: restore scan.fileName variable to keep interface the same for some legacy clients | ||
| :2014.0404.1: fix sdist utf8 problem, see: http://bugs.python.org/issue11638 | ||
| :2014.0404.0: tree_api_parser moved back into NeXpy project | ||
| :2014.0320.6: handle multiple header sections in SPEC data file | ||
| :2014.0320.5: fix the new project URL | ||
| :2014.0320.4: Sphinx cannot build PDF with code-block in a footnote | ||
| :2014.0320.3: note the new home URL in the packaging, too, drop nexpy requirement, default docs theme | ||
| :2014.0320.2: tree_api_parse will go back into nexpy project, remove docs of it here | ||
| :2014.0320.1: allow readthedocs to build Sphinx without extra package requirements | ||
| :2014.0320.0: | ||
|
|
||
| * new home page at http://spec2nexus.readthedocs.org, easier to publish there | ||
| * move common methods from __init__.py so docs will build at readthedocs.org | ||
| * new test case fails existing SPEC reader, ignore blank lines | ||
|
|
||
| :2014.03.11: documentation | ||
| :2014.03.09: h5toText: option to suppress printing of attributes, put URLs in command-line usage documentation, better test of is_spec_file() | ||
| :2014.03.08: fixed string writer and content display bug in eznx, added h5toText.py, prjPySpec docs improved again | ||
| :2014.03.051: prjPySpec now handles SPEC v6 data file header additions, add new getScanCommands() method | ||
| :2014.03.04: (2014_Mardi_Gras release) removed nexpy project requirement from setup, prjPySpec raises exceptions now | ||
| :2014.03.02: drops nexus tree API (and its dependencies) in favor of native h5py writer | ||
|
|
||
| Development: GitHub repository | ||
| ****************************** | ||
|
|
||
| :2014.02.20: version number fits PEP440, LICENSE file included in sdist, more documentation and examples | ||
| :2014-02-19: reference published documentation (re-posted) | ||
| :2014-02-19: add documentation framework | ||
| :2014-02-18: fork to GitHub to make generally available | ||
|
|
||
| Development: NeXpy branch | ||
| ************************* | ||
|
|
||
| :2014-01: briefly, a branch in https://github.com/nexpy/nexpy | ||
|
|
||
| * spec2nexus added during this phase | ||
| * relies on nexpy.api.nexus for NeXus support | ||
|
|
||
| Production: USAXS livedata | ||
| ************************** | ||
|
|
||
| :2010-2014: production use | ||
|
|
||
| * support livedata WWW page of APS USAXS instrument | ||
|
|
||
| * (http://usaxs.xray.aps.anl.gov/livedata/), | ||
|
|
||
| * https://subversion.xray.aps.anl.gov/trac/small_angle/browser/USAXS/livedata/prjPySpec.py | ||
| * converted from Tcl | ||
|
|
||
| :2000-2010: Tcl code (*readSpecData.tcl*) in production use at APS sectors 32, 33, & 34 | ||
| .. | ||
| This file describes user-visible changes between the versions. | ||
| Change History | ||
| ############## | ||
|
|
||
| Production | ||
| ********** | ||
|
|
||
| :2015.0125.0: change handling of #L & #X, refactor detection of scanNum and scanCmd | ||
| :2015.0113.0: dropped requirement of *lxml* package | ||
| :2014.1228.1: build mne:name cross-references for counters and positioners | ||
| :2014.1228.0: show version in documentation | ||
| :2014.1028.0: quietly ignore unrecognized scan content *for now* | ||
| :2014.1027.1: major changes in SPEC file support: **custom plugins** | ||
|
|
||
| * **spec** based on plugins for each control line, users can add plugins | ||
| * declared **prjPySpec** module as legacy, code is frozen at *2014.0623.0* release | ||
| * added **spec** module to replace **prjPySpec** | ||
|
|
||
| :2014.0623.0: updated argparse settings | ||
| :2014.0622.2: added extractSpecScan.py to the suite from the USAXS project | ||
| :2014.0410.0: restore scan.fileName variable to keep interface the same for some legacy clients | ||
| :2014.0404.1: fix sdist utf8 problem, see: http://bugs.python.org/issue11638 | ||
| :2014.0404.0: tree_api_parser moved back into NeXpy project | ||
| :2014.0320.6: handle multiple header sections in SPEC data file | ||
| :2014.0320.5: fix the new project URL | ||
| :2014.0320.4: Sphinx cannot build PDF with code-block in a footnote | ||
| :2014.0320.3: note the new home URL in the packaging, too, drop nexpy requirement, default docs theme | ||
| :2014.0320.2: tree_api_parse will go back into nexpy project, remove docs of it here | ||
| :2014.0320.1: allow readthedocs to build Sphinx without extra package requirements | ||
| :2014.0320.0: | ||
|
|
||
| * new home page at http://spec2nexus.readthedocs.org, easier to publish there | ||
| * move common methods from __init__.py so docs will build at readthedocs.org | ||
| * new test case fails existing SPEC reader, ignore blank lines | ||
|
|
||
| :2014.03.11: documentation | ||
| :2014.03.09: h5toText: option to suppress printing of attributes, put URLs in command-line usage documentation, better test of is_spec_file() | ||
| :2014.03.08: fixed string writer and content display bug in eznx, added h5toText.py, prjPySpec docs improved again | ||
| :2014.03.051: prjPySpec now handles SPEC v6 data file header additions, add new getScanCommands() method | ||
| :2014.03.04: (2014_Mardi_Gras release) removed nexpy project requirement from setup, prjPySpec raises exceptions now | ||
| :2014.03.02: drops nexus tree API (and its dependencies) in favor of native h5py writer | ||
|
|
||
| Development: GitHub repository | ||
| ****************************** | ||
|
|
||
| :2014.02.20: version number fits PEP440, LICENSE file included in sdist, more documentation and examples | ||
| :2014-02-19: reference published documentation (re-posted) | ||
| :2014-02-19: add documentation framework | ||
| :2014-02-18: fork to GitHub to make generally available | ||
|
|
||
| Development: NeXpy branch | ||
| ************************* | ||
|
|
||
| :2014-01: briefly, a branch in https://github.com/nexpy/nexpy | ||
|
|
||
| * spec2nexus added during this phase | ||
| * relies on nexpy.api.nexus for NeXus support | ||
|
|
||
| Production: USAXS livedata | ||
| ************************** | ||
|
|
||
| :2010-2014: production use | ||
|
|
||
| * support livedata WWW page of APS USAXS instrument | ||
|
|
||
| * (http://usaxs.xray.aps.anl.gov/livedata/), | ||
|
|
||
| * https://subversion.xray.aps.anl.gov/trac/small_angle/browser/USAXS/livedata/prjPySpec.py | ||
| * converted from Tcl | ||
|
|
||
| :2000-2010: Tcl code (*readSpecData.tcl*) in production use at APS sectors 32, 33, & 34 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,26 +1,27 @@ | ||
|
|
||
| .. index:: examples; data files | ||
|
|
||
| .. _example_data: | ||
|
|
||
| Example data | ||
| ############ | ||
|
|
||
| .. include:: ../../src/spec2nexus/data/README.txt | ||
|
|
||
| Downloads | ||
| --------- | ||
|
|
||
| These downloads are also available online: | ||
| https://github.com/prjemian/spec2nexus/tree/master/src/spec2nexus/data | ||
|
|
||
|
|
||
| * :download:`33bm_spec.dat <../../src/spec2nexus/data/33bm_spec.dat>` | ||
| * :download:`33id_spec.dat <../../src/spec2nexus/data/33id_spec.dat>` | ||
| * :download:`APS_spec_data.dat <../../src/spec2nexus/data/APS_spec_data.dat>` | ||
| * :download:`CdSe <../../src/spec2nexus/data/CdSe>` | ||
| * :download:`compression.h5 <../../src/spec2nexus/data/compression.h5>` | ||
| * :download:`Data_Q.h5 <../../src/spec2nexus/data/Data_Q.h5>` | ||
| * :download:`lmn40.spe <../../src/spec2nexus/data/lmn40.spe>` | ||
| * :download:`writer_1_3.h5 <../../src/spec2nexus/data/writer_1_3.h5>` | ||
| * :download:`YSZ011_ALDITO_Fe2O3_planar_fired_1.spc <../../src/spec2nexus/data/YSZ011_ALDITO_Fe2O3_planar_fired_1.spc>` | ||
|
|
||
| .. index:: examples; data files | ||
|
|
||
| .. _example_data: | ||
|
|
||
| Example data | ||
| ############ | ||
|
|
||
| .. include:: ../../src/spec2nexus/data/README.txt | ||
|
|
||
| Downloads | ||
| --------- | ||
|
|
||
| These downloads are also available online: | ||
| https://github.com/prjemian/spec2nexus/tree/master/src/spec2nexus/data | ||
|
|
||
|
|
||
| * :download:`33bm_spec.dat <../../src/spec2nexus/data/33bm_spec.dat>` | ||
| * :download:`33id_spec.dat <../../src/spec2nexus/data/33id_spec.dat>` | ||
| * :download:`APS_spec_data.dat <../../src/spec2nexus/data/APS_spec_data.dat>` | ||
| * :download:`CdSe <../../src/spec2nexus/data/CdSe>` | ||
| * :download:`compression.h5 <../../src/spec2nexus/data/compression.h5>` | ||
| * :download:`Data_Q.h5 <../../src/spec2nexus/data/Data_Q.h5>` | ||
| * :download:`lmn40.spe <../../src/spec2nexus/data/lmn40.spe>` | ||
| * :download:`writer_1_3.h5 <../../src/spec2nexus/data/writer_1_3.h5>` | ||
| * :download:`YSZ011_ALDITO_Fe2O3_planar_fired_1.spc <../../src/spec2nexus/data/YSZ011_ALDITO_Fe2O3_planar_fired_1.spc>` | ||
| * :download:`user6idd.dat <../../src/spec2nexus/data/user6idd.dat>` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,27 +1,26 @@ | ||
| .. restructured text format | ||
|
|
||
| About these example data files | ||
| ---------------------------------- | ||
|
|
||
| These files are examples of various | ||
| data files that may be read by **spec2nexus**. | ||
| They are used to test various components of the interface. | ||
|
|
||
|
|
||
| ====================================== ========== ========================================================================== | ||
| file type description | ||
| ====================================== ========== ========================================================================== | ||
| 33bm_spec.dat SPEC scans 1-D & 2-D scans (includes hklscan & hklmesh) | ||
| 33id_spec.dat SPEC scans 1-D & 2-D scans (includes mesh & Escan scans & MCA data) | ||
| APS_spec_data.dat SPEC scans 1-D scans (ascan & uascan), includes lots of metadata and comments | ||
| CdSe SPEC scans 1-D scans (ascan), problem with scan abort on lines 5918-9, in scan 92 | ||
| compression.h5 NeXus HDF5 2-D compressed image, also demonstrates problem to be resolved in code | ||
| Data_Q.h5 NeXus HDF5 2-D image at /entry/data/{I,Q}, test file | ||
| lmn40.spe SPEC scans 1-D & 2-D scans (hklmesh), two #E lines, has two header sections | ||
| writer_1_3.h5 NeXus HDF5 1-D NeXus User Manual example | ||
| YSZ011_ALDITO_Fe2O3_planar_fired_1.spc SPEC scans 1-D scans, text in #V metadata, also has #UIM control lines | ||
| 03_06_JanTest.dat SPEC scans 1-D scans, USAXS scans, Fly scans, #O+#o and #J+#j control lines | ||
| user6idd.dat SPEC scans 1-D scans, aborted scan, control lines: #R #UB #UE #UX #UX1 #UX2 #X, | ||
| single-space separators in #L lines, | ||
| non-default format in #X and #L lines | ||
| ====================================== ========== ========================================================================== | ||
| .. restructured text format | ||
|
|
||
| About these example data files | ||
| ---------------------------------- | ||
|
|
||
| These files are examples of various | ||
| data files that may be read by **spec2nexus**. | ||
| They are used to test various components of the interface. | ||
|
|
||
|
|
||
| ====================================== ========== ========================================================================== | ||
| file type description | ||
| ====================================== ========== ========================================================================== | ||
| 33bm_spec.dat SPEC scans 1-D & 2-D scans (includes hklscan & hklmesh) | ||
| 33id_spec.dat SPEC scans 1-D & 2-D scans (includes mesh & Escan scans & MCA data) | ||
| APS_spec_data.dat SPEC scans 1-D scans (ascan & uascan), includes lots of metadata and comments | ||
| CdSe SPEC scans 1-D scans (ascan), problem with scan abort on lines 5918-9, in scan 92 | ||
| compression.h5 NeXus HDF5 2-D compressed image, also demonstrates problem to be resolved in code | ||
| Data_Q.h5 NeXus HDF5 2-D image at /entry/data/{I,Q}, test file | ||
| lmn40.spe SPEC scans 1-D & 2-D scans (hklmesh), two #E lines, has two header sections | ||
| writer_1_3.h5 NeXus HDF5 1-D NeXus User Manual example | ||
| YSZ011_ALDITO_Fe2O3_planar_fired_1.spc SPEC scans 1-D scans, text in #V metadata, also has #UIM control lines | ||
| 03_06_JanTest.dat SPEC scans 1-D scans, USAXS scans, Fly scans, #O+#o and #J+#j control lines | ||
| user6idd.dat SPEC scans 1-D scans, aborted scan, control lines: #R #UB #UE #UX #UX1 #UX2 #X, | ||
| non-default format in #X lines | ||
| ====================================== ========== ========================================================================== |