diff --git a/.travis.yml b/.travis.yml index a6437cb..9c9101b 100644 --- a/.travis.yml +++ b/.travis.yml @@ -27,18 +27,19 @@ install: wget https://repo.continuum.io/miniconda/Miniconda3-latest-MacOSX-x86_64.sh -O miniconda.sh; fi - bash miniconda.sh -b -p $HOME/miniconda - - export PATH="$HOME/miniconda/bin:$PATH" - - hash -r + - rm miniconda.sh + - source $HOME/miniconda/etc/profile.d/conda.sh && conda activate - conda config --set always_yes yes --set changeps1 no + - conda update -q conda - conda update -q --all - conda config --append channels conda-forge - if [[ -z "$TRAVIS_TAG" ]]; then sed -i -e "s/\${PYTHON}/"${PYTHON}"/" test-environment.yaml; conda env create -qf test-environment.yaml; - source activate py${PYTHON}; + conda activate py${PYTHON}; else if [[ "$PYTHON" == "3.6" && "$TRAVIS_OS_NAME" == "linux" ]]; then - conda env update -qn root -f build-environment.yaml; + conda env update -qn base -f build-environment.yaml; fi fi # Useful for debugging any issues with conda @@ -46,7 +47,6 @@ install: - conda list # command to run tests -#script: pytest -vv --cov=./ && pylint pyked/ script: - set -e - if [[ -z "$TRAVIS_TAG" ]]; then @@ -69,7 +69,8 @@ script: cd docs; make html SPHINXOPTS="-W"; cd ..; - doctr deploy --no-require-master .; + doctr deploy --build-tags .; + doctr deploy --build-tags "tags/${TRAVIS_TAG}"; fi fi - set +e diff --git a/CHANGELOG.md b/CHANGELOG.md index 358a1ca..1711efb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -11,7 +11,17 @@ and this project adheres to [Semantic Versioning](http://semver.org/). ### Fixed -## [0.4.0] - 2018-04-07 +## [0.4.1] - 2018-03-09 +### Added +- Documentation for old versions is available on the Releases page of the docs + +### Changed + +### Fixed +- Doctr deploys on tags now +- Syntax changes for example files in the documentation + +## [0.4.0] - 2018-03-07 ### Added - New method to instantiate a `ChemKED` class directly from a ReSpecTh XML file - The `__version__` attribute can be imported from the top-level module @@ -127,6 +137,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/). - Basic API documentation is available via https://pr-omethe-us.github.io/PyKED/ [Unreleased]: https://github.com/pr-omethe-us/PyKED/compare/v0.4.0...HEAD +[0.4.1]: https://github.com/pr-omethe-us/PyKED/compare/v0.4.0...v0.4.1 [0.4.0]: https://github.com/pr-omethe-us/PyKED/compare/v0.3.0...v0.4.0 [0.3.0]: https://github.com/pr-omethe-us/PyKED/compare/v0.2.1...v0.3.0 [0.2.1]: https://github.com/pr-omethe-us/PyKED/compare/v0.2.0...v0.2.1 diff --git a/CITATION.md b/CITATION.md index f55eb39..72c97a1 100644 --- a/CITATION.md +++ b/CITATION.md @@ -4,7 +4,7 @@ To cite PyKED in a scholarly article, please use -> K. E. Niemeyer and B. W. Weber. (2018) PyKED v0.4.0 [software]. Zenodo. https://doi.org/10.5281/zenodo.597935 +> K. E. Niemeyer and B. W. Weber. (2018) PyKED v0.4.1 [software]. Zenodo. https://doi.org/10.5281/zenodo.597935 A BibTeX entry for LaTeX users is @@ -12,7 +12,7 @@ A BibTeX entry for LaTeX users is @misc{PyKED, author = {Kyle E Niemeyer and Bryan W Weber}, year = 2017, - title = {PyKED v0.4.0}, + title = {PyKED v0.4.1}, doi = {10.5281/zenodo.597935}, url = {https://github.com/pr-omethe-us/PyKED}, } @@ -23,6 +23,7 @@ given in the badge at the top, or alternately `__. + User's Guide ------------ @@ -27,6 +32,7 @@ User's Guide ck-tutorial schema-docs pyked-examples + releases Code API -------- diff --git a/docs/rcm-example.ipynb b/docs/rcm-example.ipynb index 709ac38..6552726 100644 --- a/docs/rcm-example.ipynb +++ b/docs/rcm-example.ipynb @@ -15,11 +15,11 @@ "the ChemKED file itself:\n", "\n", "```yaml\n", - "file-author:\n", - " name: Kyle E Niemeyer\n", - " ORCID: 0000-0003-4425-7097\n", + "file-authors:\n", + " - name: Kyle E Niemeyer\n", + " ORCID: 0000-0003-4425-7097\n", "file-version: 0\n", - "chemked-version: 0.1.6\n", + "chemked-version: 0.4.0\n", "```\n", "\n", "Then, we find the information regarding the article in the literature from which\n", @@ -84,23 +84,25 @@ " ignition-type:\n", " target: pressure\n", " type: d/dt max\n", - " compression-time:\n", - " - 38.0 ms\n", - " volume-history:\n", - " time:\n", - " units: s\n", - " column: 0\n", - " volume:\n", - " units: cm3\n", - " column: 1\n", - " values:\n", - " - [0.00E+000, 5.47669375000E+002]\n", - " - [1.00E-003, 5.46608789894E+002]\n", - " - [2.00E-003, 5.43427034574E+002]\n", - " ...\n", + " rcm-data:\n", + " compression-time:\n", + " - 38.0 ms\n", + " time-histories:\n", + " - type: volume\n", + " time:\n", + " units: s\n", + " column: 0\n", + " volume:\n", + " units: cm3\n", + " column: 1\n", + " values:\n", + " - [0.00E+000, 5.47669375000E+002]\n", + " - [1.00E-003, 5.46608789894E+002]\n", + " - [2.00E-003, 5.43427034574E+002]\n", + " ...\n", "```\n", "\n", - "The values for the `volume-history` are truncated here to save space. One application of the\n", + "The values for the volume history in the `time-histories` key are truncated here to save space. One application of the\n", "data stored in this file is to perform a simulation using [Cantera][Cantera] to\n", "calculate the ignition delay, including the facility-dependent effects represented in the volume\n", "trace. All information required to perform this simulation is present in the ChemKED file, with the\n", @@ -1976,7 +1978,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.6.2" + "version": "3.6.4" } }, "nbformat": 4, diff --git a/docs/releases.rst b/docs/releases.rst new file mode 100644 index 0000000..a9639d0 --- /dev/null +++ b/docs/releases.rst @@ -0,0 +1,71 @@ +.. _releases: + +======== +Releases +======== + +v0.4.0 - 2018-03-07 +------------------- +* `Documentation `__ +* `Changelog `__ +* `Zenodo `__ + +v0.3.0 - 2017-10-09 +------------------- +* `Documentation `__ +* `Changelog `__ +* `Zenodo `__ + +v0.2.1 - 2017-08-31 +------------------- +* `Documentation `__ +* `Changelog `__ +* `Zenodo `__ + +v0.2.0 - 2017-08-10 +------------------- +* `Documentation `__ +* `Changelog `__ +* `Zenodo `__ + +v0.1.6 - 2017-07-17 +------------------- +* `Documentation `__ +* `Changelog `__ +* `Zenodo `__ + +v0.1.5 - 2017-05-22 +------------------- +* `Documentation `__ +* `Changelog `__ +* `Zenodo `__ + +v0.1.4 - 2017-04-21 +------------------- +* `Documentation `__ +* `Changelog `__ +* `Zenodo `__ + +v0.1.3 - 2017-04-13 +------------------- +* `Documentation `__ +* `Changelog `__ +* `Zenodo `__ + +v0.1.2 - 2017-04-13 +------------------- +* `Documentation `__ +* `Changelog `__ +* `Zenodo `__ + +v0.1.1 - 2017-04-02 +------------------- +* `Documentation `__ +* `Changelog `__ +* `Zenodo `__ + +v0.1.0 - 2017-04-02 +------------------- +* `Documentation `__ +* `Changelog `__ +* `Zenodo `__ diff --git a/docs/shock-tube-example.ipynb b/docs/shock-tube-example.ipynb index 1a73ea4..59d6391 100644 --- a/docs/shock-tube-example.ipynb +++ b/docs/shock-tube-example.ipynb @@ -18,9 +18,9 @@ "The file starts with the meta information about the ChemKED file itself:\n", "\n", "```yaml\n", - "file-author:\n", - " name: Morgan Mayer\n", - " ORCID: 0000-0001-7137-5721\n", + "file-authors:\n", + " - name: Morgan Mayer\n", + " ORCID: 0000-0001-7137-5721\n", "file-version: 0\n", "chemked-version: 0.0.1\n", "```\n", @@ -1077,7 +1077,7 @@ "name": "python", "nbconvert_exporter": "python", "pygments_lexer": "ipython3", - "version": "3.6.2" + "version": "3.6.4" } }, "nbformat": 4, diff --git a/pyked/_version.py b/pyked/_version.py index 36413af..e39576e 100644 --- a/pyked/_version.py +++ b/pyked/_version.py @@ -1,4 +1,4 @@ -__version_info__ = (0, 4, 0) +__version_info__ = (0, 4, 1) __version__ = '.'.join(map(str, __version_info__[:3])) if len(__version_info__) == 4: __version__ += __version_info__[-1] diff --git a/pyked/schemas/chemked_schema.yaml b/pyked/schemas/chemked_schema.yaml index 5576a64..3592089 100644 --- a/pyked/schemas/chemked_schema.yaml +++ b/pyked/schemas/chemked_schema.yaml @@ -87,6 +87,7 @@ chemked-version: # TODO: Implement proper version comparison - 0.2.1 - 0.3.0 - 0.4.0 + - 0.4.1 required: true type: string experiment-type: diff --git a/pyked/validation.py b/pyked/validation.py index cb1020f..4814201 100644 --- a/pyked/validation.py +++ b/pyked/validation.py @@ -176,7 +176,7 @@ def _validate_isvalid_t_range(self, isvalid_t_range, field, values): field (`str`): T_range values (`list`): List of temperature values indicating low, middle, and high ranges - The rule's arguemnts are validated against this schema: + The rule's arguments are validated against this schema: {'isvalid_t_range': {'type': 'bool'}, 'field': {'type': 'str'}, 'value': {'type': 'list'}} """