-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
9 changed files
with
148 additions
and
2 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
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 |
---|---|---|
@@ -0,0 +1,6 @@ | ||
#---------- 14 Nov 2018 | ||
This repository uses the MkDocs (v0.17.2) utilities for documentation rendering. | ||
From the repo root directory, "mkdocs --help" shows the options. | ||
"mkdocs build" for example, writes a set of html documents under the ./site subdirectory | ||
|
||
(Aside: ./site is NOT currently in the .gitignore file; insertion pending for consistency). |
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,5 +1,5 @@ | ||
site_name: QGL | ||
pages: | ||
nav: | ||
- Intro: index.md | ||
- Configuration: config.md | ||
- Examples: examples.md | ||
|
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 |
---|---|---|
@@ -0,0 +1,26 @@ | ||
#!/bin/bash | ||
echo "" | ||
echo "#---------- $0 (QGL) start..." | ||
echo "" | ||
#----- Simple script to capture basic documentation rendering logic. | ||
|
||
echo "#-----Building QGL docs via ~:" | ||
|
||
export CMD="mkdocs build" | ||
echo $CMD | ||
echo "" | ||
$CMD | ||
|
||
pushd . | ||
|
||
cd site | ||
echo "" | ||
echo "Target QGL documents list as follows:" | ||
pwd | ||
ls -l | ||
|
||
|
||
echo "" | ||
echo "#---------- $0 (QGL) stop." | ||
echo "" | ||
|
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 |
---|---|---|
@@ -0,0 +1,74 @@ | ||
#!/bin/bash | ||
echo "" | ||
echo "#---------- $0 (QGL) start..." | ||
echo "" | ||
#----- Simple script to capture unittest preparation and invocation logic. | ||
|
||
pwd | ||
|
||
export szGit_LFS_Path=`which git-lfs` | ||
echo "szGit_LFS_Path: [${szGit_LFS_Path}]" | ||
|
||
|
||
# Instantiate the git lfs cached data files... | ||
export CMD="git lfs pull" | ||
echo "" | ||
if [ -z ${szGit_LFS_Path} ]; then | ||
echo "" | ||
echo "#--------------------" | ||
echo "# W A R N I N G -- git-lfs extension library unavailable;" | ||
echo "# -- QGL h5 data file processing may fail." | ||
echo "# << [${szGit_LFS_Path}] << 'which git-lfs'" | ||
echo "#--------------------" | ||
else | ||
echo "git-lfs available; retrieving/instantiating cached QGL h5 data files via ~:" | ||
echo $CMD | ||
echo "" | ||
$CMD | ||
fi | ||
echo "" | ||
|
||
|
||
# Don't forget to set the BBN_MEAS_FILE reference. | ||
export BBN_MEAS_FILE=tests/test_measure.yml | ||
|
||
echo "" | ||
echo "#-----Unit-Testing general QGL (BBN_MEAS_FILE=${BBN_MEAS_FILE}) via ~:" | ||
# -f option fails fast | ||
#export CMD="python -m unittest discover . -v -f" | ||
#export CMD="python -m unittest discover . -v" | ||
# Trimm'ed down (non LFS unitest calls) syntax as follows: | ||
export CMD="python -m unittest tests/test_A*.py tests/test_C*.py tests/test_Scheduler.py tests/test_config.py tests/test_pulse_types.py -v" | ||
echo $CMD | ||
echo "" | ||
$CMD | ||
|
||
if [ -z ${szGit_LFS_Path} ]; then | ||
echo "" | ||
echo "#----- W A R N I N G:" | ||
echo " Fast-failing unittest modules test_QGL.py, and test_Sequences.py," | ||
echo " currently, due to git lfs data file dependencies; in-short, the" | ||
echo " docker continuumio/miniconda load appears to omit the necessary" | ||
echo " git-lfs library installation." | ||
echo "" | ||
echo " Without the git-lfs library extension, h5 data calls from these" | ||
echo " modules typically error out with ~:" | ||
echo " OSError: Unable to open file (file signature not found)" | ||
echo "" | ||
echo " If/when the git-lfs library becomes available in the docker load, " | ||
echo " remove the \"-f\"from the invocation, below:" | ||
fi | ||
|
||
echo "" | ||
echo "#----- Testing LFS data file dependent QGL modules via ~:" | ||
# Careful -- in this format (tests.moduleName) DON'T cite the .py suffix | ||
# (it will render an odd error regarding missing 'py' attribute) | ||
export CMD="python -m unittest tests.test_QGL tests.test_Sequences -v -f" | ||
echo $CMD | ||
echo "" | ||
$CMD | ||
|
||
echo "" | ||
echo "#---------- $0 (QGL) stop." | ||
echo "" | ||
|
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
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
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
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