| Name | dkist-processing-dlnirsp JSON |
| Version |
0.18.0
JSON |
| download |
| home_page | None |
| Summary | Science processing code for the DLNIRSP instrument on DKIST |
| upload_time | 2024-12-04 22:04:36 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | BSD-3-Clause |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
dkist-processing-dlnirsp
========================
Overview
--------
The dkist-processing-dlnirsp library contains the implementation of the DLNIRSP pipelines as a collection of the
`dkist-processing-core <https://pypi.org/project/dkist-processing-core/>`_ framework and
`dkist-processing-common <https://pypi.org/project/dkist-processing-common/>`_ Tasks.
The recommended project structure is to separate tasks and workflows into separate packages. Having the workflows
in their own package facilitates using the build_utils to test the integrity of those workflows in the unit test.
Calibration Pipeline
------------------------
Build
--------
Artifacts are built through Bitbucket Pipelines.
The pipeline can be used in other repos with a modification of the package and artifact locations
to use the names relevant to the target repo.
e.g. dkist-processing-test -> dkist-processing-vbi and dkist_processing_test -> dkist_processing_vbi
Deployment
----------
Deployment is done with `turtlebot <https://bitbucket.org/dkistdc/turtlebot/src/master/>`_ and follows
the process detailed in `dkist-processing-core <https://pypi.org/project/dkist-processing-core/>`_
Environment Variables
---------------------
Only those specified by `dkist-processing-core <https://pypi.org/project/dkist-processing-core/>`_ and `dkist-processing-common <https://pypi.org/project/dkist-processing-common/>`_.
Development
-----------
.. code-block:: bash
git clone git@bitbucket.org:dkistdc/dkist-processing-dlnirsp.git
cd dkist-processing-dlnirsp
pre-commit install
pip install -e .[test]
pytest -v --cov dkist_processing_nirsp
Changelog
#########
When you make **any** change to this repository it **MUST** be accompanied by a changelog file.
The changelog for this repository uses the `towncrier <https://github.com/twisted/towncrier>`__ package.
Entries in the changelog for the next release are added as individual files (one per change) to the ``changelog/`` directory.
Writing a Changelog Entry
^^^^^^^^^^^^^^^^^^^^^^^^^
A changelog entry accompanying a change should be added to the ``changelog/`` directory.
The name of a file in this directory follows a specific template::
<PULL REQUEST NUMBER>.<TYPE>[.<COUNTER>].rst
The fields have the following meanings:
* ``<PULL REQUEST NUMBER>``: This is the number of the pull request, so people can jump from the changelog entry to the diff on BitBucket.
* ``<TYPE>``: This is the type of the change and must be one of the values described below.
* ``<COUNTER>``: This is an optional field, if you make more than one change of the same type you can append a counter to the subsequent changes, i.e. ``100.bugfix.rst`` and ``100.bugfix.1.rst`` for two bugfix changes in the same PR.
The list of possible types is defined in the towncrier section of ``pyproject.toml``, the types are:
* ``feature``: This change is a new code feature.
* ``bugfix``: This is a change which fixes a bug.
* ``doc``: A documentation change.
* ``removal``: A deprecation or removal of public API.
* ``misc``: Any small change which doesn't fit anywhere else, such as a change to the package infrastructure.
Rendering the Changelog at Release Time
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
When you are about to tag a release first you must run ``towncrier`` to render the changelog.
The steps for this are as follows:
* Run `towncrier build --version vx.y.z` using the version number you want to tag.
* Agree to have towncrier remove the fragments.
* Add and commit your changes.
* Tag the release.
**NOTE:** If you forget to add a Changelog entry to a tagged release (either manually or automatically with ``towncrier``)
then the Bitbucket pipeline will fail. To be able to use the same tag you must delete it locally and on the remote branch:
.. code-block:: bash
# First, actually update the CHANGELOG and commit the update
git commit
# Delete tags
git tag -d vWHATEVER.THE.VERSION
git push --delete origin vWHATEVER.THE.VERSION
# Re-tag with the same version
git tag vWHATEVER.THE.VERSION
git push --tags origin main
Science Changelog
^^^^^^^^^^^^^^^^^
Whenever a release involves changes to the scientific quality of L1 data, additional changelog fragment(s) should be
created. These fragments are intended to be as verbose as is needed to accurately capture the scope of the change(s),
so feel free to use all the fancy RST you want. Science fragments are placed in the same ``changelog/`` directory
as other fragments, but are always called::
<PR NUMBER | +>.science[.<COUNTER>].rst
In the case that a single pull request encapsulates the entirety of the scientific change then the first field should
be that PR number (same as the normal CHANGELOG). If, however, there is not a simple mapping from a single PR to a scienctific
change then use the character "+" instead; this will create a changelog entry with no associated PR. For example:
.. code-block:: bash
$ ls changelog/
99.bugfix.rst # This is a normal changelog fragment associated with a bugfix in PR 99
99.science.rst # Apparently that bugfix also changed the scientific results, so that PR also gets a science fragment
+.science.rst # This fragment is not associated with a PR
When it comes time to build the SCIENCE_CHANGELOG, use the ``science_towncrier.sh`` script in this repo to do so.
This script accepts all the same arguments as the default `towncrier`. For exmaple:
.. code-block:: bash
./science_towncrier.sh build --version vx.y.z
This will update the SCIENCE_CHANGELOG and remove any science fragments from the changelog directory.
Raw data
{
"_id": null,
"home_page": null,
"name": "dkist-processing-dlnirsp",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "NSO / AURA <dkistdc@nso.edu>",
"download_url": "https://files.pythonhosted.org/packages/2c/3c/6497015b9a1377a1425ee03a48462ce181c41316b6be92285d190d64c4d4/dkist_processing_dlnirsp-0.18.0.tar.gz",
"platform": null,
"description": "dkist-processing-dlnirsp\n========================\n\nOverview\n--------\nThe dkist-processing-dlnirsp library contains the implementation of the DLNIRSP pipelines as a collection of the\n`dkist-processing-core <https://pypi.org/project/dkist-processing-core/>`_ framework and\n`dkist-processing-common <https://pypi.org/project/dkist-processing-common/>`_ Tasks.\n\nThe recommended project structure is to separate tasks and workflows into separate packages. Having the workflows\nin their own package facilitates using the build_utils to test the integrity of those workflows in the unit test.\n\nCalibration Pipeline\n------------------------\n\nBuild\n--------\nArtifacts are built through Bitbucket Pipelines.\n\nThe pipeline can be used in other repos with a modification of the package and artifact locations\nto use the names relevant to the target repo.\n\ne.g. dkist-processing-test -> dkist-processing-vbi and dkist_processing_test -> dkist_processing_vbi\n\nDeployment\n----------\nDeployment is done with `turtlebot <https://bitbucket.org/dkistdc/turtlebot/src/master/>`_ and follows\nthe process detailed in `dkist-processing-core <https://pypi.org/project/dkist-processing-core/>`_\n\nEnvironment Variables\n---------------------\nOnly those specified by `dkist-processing-core <https://pypi.org/project/dkist-processing-core/>`_ and `dkist-processing-common <https://pypi.org/project/dkist-processing-common/>`_.\n\nDevelopment\n-----------\n.. code-block:: bash\n\n git clone git@bitbucket.org:dkistdc/dkist-processing-dlnirsp.git\n cd dkist-processing-dlnirsp\n pre-commit install\n pip install -e .[test]\n pytest -v --cov dkist_processing_nirsp\n\nChangelog\n#########\n\nWhen you make **any** change to this repository it **MUST** be accompanied by a changelog file.\nThe changelog for this repository uses the `towncrier <https://github.com/twisted/towncrier>`__ package.\nEntries in the changelog for the next release are added as individual files (one per change) to the ``changelog/`` directory.\n\nWriting a Changelog Entry\n^^^^^^^^^^^^^^^^^^^^^^^^^\n\nA changelog entry accompanying a change should be added to the ``changelog/`` directory.\nThe name of a file in this directory follows a specific template::\n\n <PULL REQUEST NUMBER>.<TYPE>[.<COUNTER>].rst\n\nThe fields have the following meanings:\n\n* ``<PULL REQUEST NUMBER>``: This is the number of the pull request, so people can jump from the changelog entry to the diff on BitBucket.\n* ``<TYPE>``: This is the type of the change and must be one of the values described below.\n* ``<COUNTER>``: This is an optional field, if you make more than one change of the same type you can append a counter to the subsequent changes, i.e. ``100.bugfix.rst`` and ``100.bugfix.1.rst`` for two bugfix changes in the same PR.\n\nThe list of possible types is defined in the towncrier section of ``pyproject.toml``, the types are:\n\n* ``feature``: This change is a new code feature.\n* ``bugfix``: This is a change which fixes a bug.\n* ``doc``: A documentation change.\n* ``removal``: A deprecation or removal of public API.\n* ``misc``: Any small change which doesn't fit anywhere else, such as a change to the package infrastructure.\n\n\nRendering the Changelog at Release Time\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\nWhen you are about to tag a release first you must run ``towncrier`` to render the changelog.\nThe steps for this are as follows:\n\n* Run `towncrier build --version vx.y.z` using the version number you want to tag.\n* Agree to have towncrier remove the fragments.\n* Add and commit your changes.\n* Tag the release.\n\n**NOTE:** If you forget to add a Changelog entry to a tagged release (either manually or automatically with ``towncrier``)\nthen the Bitbucket pipeline will fail. To be able to use the same tag you must delete it locally and on the remote branch:\n\n.. code-block:: bash\n\n # First, actually update the CHANGELOG and commit the update\n git commit\n\n # Delete tags\n git tag -d vWHATEVER.THE.VERSION\n git push --delete origin vWHATEVER.THE.VERSION\n\n # Re-tag with the same version\n git tag vWHATEVER.THE.VERSION\n git push --tags origin main\n\nScience Changelog\n^^^^^^^^^^^^^^^^^\n\nWhenever a release involves changes to the scientific quality of L1 data, additional changelog fragment(s) should be\ncreated. These fragments are intended to be as verbose as is needed to accurately capture the scope of the change(s),\nso feel free to use all the fancy RST you want. Science fragments are placed in the same ``changelog/`` directory\nas other fragments, but are always called::\n\n <PR NUMBER | +>.science[.<COUNTER>].rst\n\nIn the case that a single pull request encapsulates the entirety of the scientific change then the first field should\nbe that PR number (same as the normal CHANGELOG). If, however, there is not a simple mapping from a single PR to a scienctific\nchange then use the character \"+\" instead; this will create a changelog entry with no associated PR. For example:\n\n.. code-block:: bash\n\n $ ls changelog/\n 99.bugfix.rst # This is a normal changelog fragment associated with a bugfix in PR 99\n 99.science.rst # Apparently that bugfix also changed the scientific results, so that PR also gets a science fragment\n +.science.rst # This fragment is not associated with a PR\n\n\nWhen it comes time to build the SCIENCE_CHANGELOG, use the ``science_towncrier.sh`` script in this repo to do so.\nThis script accepts all the same arguments as the default `towncrier`. For exmaple:\n\n.. code-block:: bash\n\n ./science_towncrier.sh build --version vx.y.z\n\nThis will update the SCIENCE_CHANGELOG and remove any science fragments from the changelog directory.\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Science processing code for the DLNIRSP instrument on DKIST",
"version": "0.18.0",
"project_urls": {
"Documentation": "https://docs.dkist.nso.edu/projects/dl-nirsp",
"Help": "https://nso.atlassian.net/servicedesk/customer/portal/5",
"Homepage": "https://nso.edu/dkist/data-center/",
"Repository": "https://bitbucket.org/dkistdc/dkist-processing-dlnirsp/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "74e75160569908d6e615c0b9ec737fdb43adb941c28df05ca06dd8a18785dfbc",
"md5": "6d4c83d2524ae84d345def1fb31bd0c7",
"sha256": "c72c31a32da4f8adf38024cb1532941659e482897709a55c6a7dd63e36ce4544"
},
"downloads": -1,
"filename": "dkist_processing_dlnirsp-0.18.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6d4c83d2524ae84d345def1fb31bd0c7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 173271,
"upload_time": "2024-12-04T22:04:34",
"upload_time_iso_8601": "2024-12-04T22:04:34.525070Z",
"url": "https://files.pythonhosted.org/packages/74/e7/5160569908d6e615c0b9ec737fdb43adb941c28df05ca06dd8a18785dfbc/dkist_processing_dlnirsp-0.18.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2c3c6497015b9a1377a1425ee03a48462ce181c41316b6be92285d190d64c4d4",
"md5": "0b81cfd9180d1b48100c0e9709fc14fc",
"sha256": "11b962651c4730f9d54433e4854dfac5e0509a303cc14cdd4369106e5a4061ef"
},
"downloads": -1,
"filename": "dkist_processing_dlnirsp-0.18.0.tar.gz",
"has_sig": false,
"md5_digest": "0b81cfd9180d1b48100c0e9709fc14fc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 137520,
"upload_time": "2024-12-04T22:04:36",
"upload_time_iso_8601": "2024-12-04T22:04:36.646357Z",
"url": "https://files.pythonhosted.org/packages/2c/3c/6497015b9a1377a1425ee03a48462ce181c41316b6be92285d190d64c4d4/dkist_processing_dlnirsp-0.18.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-04 22:04:36",
"github": false,
"gitlab": false,
"bitbucket": true,
"codeberg": false,
"bitbucket_user": "dkistdc",
"bitbucket_project": "dkist-processing-dlnirsp",
"lcname": "dkist-processing-dlnirsp"
}
