Colour - CLF IO
===============
.. start-badges
|actions| |coveralls| |codacy| |version|
.. |actions| image:: https://img.shields.io/github/actions/workflow/status/colour-science/colour-clf-io/.github/workflows/continuous-integration-quality-unit-tests.yml?branch=develop&style=flat-square
:target: https://github.com/colour-science/colour-clf-io/actions
:alt: Develop Build Status
.. |coveralls| image:: http://img.shields.io/coveralls/colour-science/colour-clf-io/develop.svg?style=flat-square
:target: https://coveralls.io/r/colour-science/colour-clf-io
:alt: Coverage Status
.. |codacy| image:: https://img.shields.io/codacy/grade/f422dc0703dd4653b2b766217c745813/develop.svg?style=flat-square
:target: https://app.codacy.com/gh/colour-science/colour-clf-io
:alt: Code Grade
.. |version| image:: https://img.shields.io/pypi/v/colour-clf-io.svg?style=flat-square
:target: https://pypi.org/project/colour-clf-io
:alt: Package Version
.. end-badges
A `Python <https://www.python.org>`__ package implementing functionality to read and write files in the `Common LUT
Format (CLF) <https://docs.acescentral.com/specifications/clf/>`__.
It is open source and freely available under the
`BSD-3-Clause <https://opensource.org/licenses/BSD-3-Clause>`__ terms.
.. contents:: **Table of Contents**
:backlinks: none
:depth: 2
.. sectnum::
Features
--------
The following features are available:
- Reading *CLF* files to a Python representation.
The following features are planned and in development:
- Writing *CLF* files from the Python representation.
- Validating *CLF* files according to the specification.
Features that will not be part of this library:
- Executing *CLF* workflows and applying them to colours or images. This feature will be implemented as part of `Colour
<https://github.com/colour-science/colour/>`__.
Examples
^^^^^^^^
The main entry point of the library is the ``read_clf`` function in the main namespace.
.. code-block:: python
import colour_clf_io
example = """
<?xml version="1.0" ?>
<ProcessList xmlns="urn:AMPAS:CLF:v3.0" id="Example Wrapper" compCLFversion="2.0">
<LUT3D id="lut-24" name="green look" interpolation="trilinear" inBitDepth="12i" outBitDepth="16f">
<Description>3D LUT</Description>
<Array dim="2 2 2 3">
0.0 0.0 0.0
0.0 0.0 1.0
0.0 1.0 0.0
0.0 1.0 1.0
1.0 0.0 0.0
1.0 0.0 1.0
1.0 1.0 0.0
1.0 1.0 1.0
</Array>
</LUT3D>
</ProcessList>
""" # noqa: E501
clf_doc = colour_clf_io.read_clf(EXAMPLE_WRAPPER.format(example))
print(clf_doc)
.. code-block:: text
ProcessList(id='Example Wrapper', compatible_CLF_version='3.0', process_nodes=[LUT3D(id='lut-24', name='green look', in_bit_depth=<BitDepth.i12: '12i'>, out_bit_depth=<BitDepth.f16: '16f'>, description='3D LUT', array=Array(values=[0.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 1.0, 0.0, 0.0, 1.0, 1.0, 1.0, 0.0, 0.0, 1.0, 0.0, 1.0, 1.0, 1.0, 0.0, 1.0, 1.0, 1.0], dim=(2, 2, 2, 3)), half_domain=False, raw_halfs=False, interpolation=<Interpolation3D.TRILINEAR: 'trilinear'>)], name=None, inverse_of=None, description=[], input_descriptor='', output_descriptor='', info=Info(app_release=None, copyright=None, revision=None, aces_transform_id=None, aces_user_name=None, calibration_info=None))
User Guide
----------
Installation
^^^^^^^^^^^^
Primary Dependencies
~~~~~~~~~~~~~~~~~~~~
**Colour - CLF IO** requires various dependencies in order to run:
- `python >= 3.10, < 4 <https://www.python.org/download/releases>`__
- `lxml >= 5.2.1 < 6 <https://pypi.org/project/lxml/>`__
- `numpy >= 1.24, < 2 <https://pypi.org/project/numpy>`__
Pypi
~~~~
Once the dependencies are satisfied, **Colour - CLF IO** can be installed from
the `Python Package Index <http://pypi.python.org/pypi/colour-datasets>`__ by
issuing this command in a shell::
pip install --user colour-clf-io
The overall development dependencies are installed as follows::
pip install --user 'colour-clf-io[development]'
Contributing
^^^^^^^^^^^^
If you would like to contribute to `Colour - CLF IO <https://github.com/colour-science/colour-clf-io>`__,
please refer to the following `Contributing <https://www.colour-science.org/contributing>`__
guide for `Colour <https://github.com/colour-science/colour>`__.
Bibliography
^^^^^^^^^^^^
The bibliography is available in the repository in
`BibTeX <https://github.com/colour-science/colour-clf-io/blob/develop/BIBLIOGRAPHY.bib>`__
format.
API Reference
-------------
The main technical reference for `Colour - CLF IO <https://github.com/colour-science/colour-clf-io>`__
is the `API Reference <https://colour-clf-io.readthedocs.io/en/latest/reference.html>`__.
See Also
--------
Publications
^^^^^^^^^^^^
- `Common LUT Format (CLF) - A Common File Format for Look-Up Tables
<https://docs.acescentral.com/specifications/clf/>`__ by the Academy of Motion Picture Arts & Sciences.
Software
^^^^^^^^
*OpenColorIO* was used to verify parsing through the builtin transforms that are part of the library.
Code of Conduct
---------------
The *Code of Conduct*, adapted from the `Contributor Covenant 1.4 <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>`__,
is available on the `Code of Conduct <https://www.colour-science.org/code-of-conduct>`__ page.
Contact & Social
----------------
The *Colour Developers* can be reached via different means:
- `Email <mailto:colour-developers@colour-science.org>`__
- `Facebook <https://www.facebook.com/python.colour.science>`__
- `Github Discussions <https://github.com/colour-science/colour-clf-io/discussions>`__
- `Gitter <https://gitter.im/colour-science/colour>`__
- `X <https://x.com/colour_science>`__
- `Bluesky <https://bsky.app/profile/colour-science.bsky.social>`__
About
-----
| **Colour - CLF IO** by Colour Developers
| Copyright 2024 Colour Developers – `colour-developers@colour-science.org <colour-developers@colour-science.org>`__
| This software is released under terms of BSD-3-Clause: https://opensource.org/licenses/BSD-3-Clause
| `https://github.com/colour-science/colour-clf-io <https://github.com/colour-science/colour-clf-io>`__
Raw data
{
"_id": null,
"home_page": null,
"name": "colour-clf-io",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.14,>=3.10",
"maintainer_email": "Colour Developers <colour-developers@colour-science.org>",
"keywords": "CLF, color, color-science, color-space, color-spaces, colorspace, colorspaces, colour, colour-science, colour-space, colour-spaces, colourspace, colourspaces, common lut format, python",
"author": null,
"author_email": "Colour Developers <colour-developers@colour-science.org>",
"download_url": "https://files.pythonhosted.org/packages/1c/07/e0fe84cc8edc37e42e7e981bf1a7c0d299f40a19a732b37bc9e2fe70b6d8/colour_clf_io-0.1.1.tar.gz",
"platform": null,
"description": "Colour - CLF IO\n===============\n\n.. start-badges\n\n|actions| |coveralls| |codacy| |version|\n\n.. |actions| image:: https://img.shields.io/github/actions/workflow/status/colour-science/colour-clf-io/.github/workflows/continuous-integration-quality-unit-tests.yml?branch=develop&style=flat-square\n :target: https://github.com/colour-science/colour-clf-io/actions\n :alt: Develop Build Status\n.. |coveralls| image:: http://img.shields.io/coveralls/colour-science/colour-clf-io/develop.svg?style=flat-square\n :target: https://coveralls.io/r/colour-science/colour-clf-io\n :alt: Coverage Status\n.. |codacy| image:: https://img.shields.io/codacy/grade/f422dc0703dd4653b2b766217c745813/develop.svg?style=flat-square\n :target: https://app.codacy.com/gh/colour-science/colour-clf-io\n :alt: Code Grade\n.. |version| image:: https://img.shields.io/pypi/v/colour-clf-io.svg?style=flat-square\n :target: https://pypi.org/project/colour-clf-io\n :alt: Package Version\n\n.. end-badges\n\nA `Python <https://www.python.org>`__ package implementing functionality to read and write files in the `Common LUT\nFormat (CLF) <https://docs.acescentral.com/specifications/clf/>`__.\n\nIt is open source and freely available under the\n`BSD-3-Clause <https://opensource.org/licenses/BSD-3-Clause>`__ terms.\n\n.. contents:: **Table of Contents**\n :backlinks: none\n :depth: 2\n\n.. sectnum::\n\nFeatures\n--------\n\nThe following features are available:\n\n- Reading *CLF* files to a Python representation.\n\nThe following features are planned and in development:\n\n- Writing *CLF* files from the Python representation.\n- Validating *CLF* files according to the specification.\n\nFeatures that will not be part of this library:\n\n- Executing *CLF* workflows and applying them to colours or images. This feature will be implemented as part of `Colour\n <https://github.com/colour-science/colour/>`__.\n\nExamples\n^^^^^^^^\n\nThe main entry point of the library is the ``read_clf`` function in the main namespace.\n\n.. code-block:: python\n\n import colour_clf_io\n\n example = \"\"\"\n <?xml version=\"1.0\" ?>\n <ProcessList xmlns=\"urn:AMPAS:CLF:v3.0\" id=\"Example Wrapper\" compCLFversion=\"2.0\">\n <LUT3D id=\"lut-24\" name=\"green look\" interpolation=\"trilinear\" inBitDepth=\"12i\" outBitDepth=\"16f\">\n <Description>3D LUT</Description>\n <Array dim=\"2 2 2 3\">\n 0.0 0.0 0.0\n 0.0 0.0 1.0\n 0.0 1.0 0.0\n 0.0 1.0 1.0\n 1.0 0.0 0.0\n 1.0 0.0 1.0\n 1.0 1.0 0.0\n 1.0 1.0 1.0\n </Array>\n </LUT3D>\n </ProcessList>\n \"\"\" # noqa: E501\n clf_doc = colour_clf_io.read_clf(EXAMPLE_WRAPPER.format(example))\n print(clf_doc)\n\n.. code-block:: text\n\n ProcessList(id='Example Wrapper', compatible_CLF_version='3.0', process_nodes=[LUT3D(id='lut-24', name='green look', in_bit_depth=<BitDepth.i12: '12i'>, out_bit_depth=<BitDepth.f16: '16f'>, description='3D LUT', array=Array(values=[0.0, 0.0, 0.0, 0.0, 0.0, 1.0, 0.0, 1.0, 0.0, 0.0, 1.0, 1.0, 1.0, 0.0, 0.0, 1.0, 0.0, 1.0, 1.0, 1.0, 0.0, 1.0, 1.0, 1.0], dim=(2, 2, 2, 3)), half_domain=False, raw_halfs=False, interpolation=<Interpolation3D.TRILINEAR: 'trilinear'>)], name=None, inverse_of=None, description=[], input_descriptor='', output_descriptor='', info=Info(app_release=None, copyright=None, revision=None, aces_transform_id=None, aces_user_name=None, calibration_info=None))\n\nUser Guide\n----------\n\nInstallation\n^^^^^^^^^^^^\n\nPrimary Dependencies\n~~~~~~~~~~~~~~~~~~~~\n\n**Colour - CLF IO** requires various dependencies in order to run:\n\n- `python >= 3.10, < 4 <https://www.python.org/download/releases>`__\n- `lxml >= 5.2.1 < 6 <https://pypi.org/project/lxml/>`__\n- `numpy >= 1.24, < 2 <https://pypi.org/project/numpy>`__\n\nPypi\n~~~~\n\nOnce the dependencies are satisfied, **Colour - CLF IO** can be installed from\nthe `Python Package Index <http://pypi.python.org/pypi/colour-datasets>`__ by\nissuing this command in a shell::\n\n pip install --user colour-clf-io\n\nThe overall development dependencies are installed as follows::\n\n pip install --user 'colour-clf-io[development]'\n\n\nContributing\n^^^^^^^^^^^^\n\nIf you would like to contribute to `Colour - CLF IO <https://github.com/colour-science/colour-clf-io>`__,\nplease refer to the following `Contributing <https://www.colour-science.org/contributing>`__\nguide for `Colour <https://github.com/colour-science/colour>`__.\n\nBibliography\n^^^^^^^^^^^^\n\nThe bibliography is available in the repository in\n`BibTeX <https://github.com/colour-science/colour-clf-io/blob/develop/BIBLIOGRAPHY.bib>`__\nformat.\n\nAPI Reference\n-------------\n\nThe main technical reference for `Colour - CLF IO <https://github.com/colour-science/colour-clf-io>`__\nis the `API Reference <https://colour-clf-io.readthedocs.io/en/latest/reference.html>`__.\n\nSee Also\n--------\n\nPublications\n^^^^^^^^^^^^\n\n- `Common LUT Format (CLF) - A Common File Format for Look-Up Tables\n <https://docs.acescentral.com/specifications/clf/>`__ by the Academy of Motion Picture Arts & Sciences.\n\nSoftware\n^^^^^^^^\n\n*OpenColorIO* was used to verify parsing through the builtin transforms that are part of the library.\n\nCode of Conduct\n---------------\n\nThe *Code of Conduct*, adapted from the `Contributor Covenant 1.4 <https://www.contributor-covenant.org/version/1/4/code-of-conduct.html>`__,\nis available on the `Code of Conduct <https://www.colour-science.org/code-of-conduct>`__ page.\n\nContact & Social\n----------------\n\nThe *Colour Developers* can be reached via different means:\n\n- `Email <mailto:colour-developers@colour-science.org>`__\n- `Facebook <https://www.facebook.com/python.colour.science>`__\n- `Github Discussions <https://github.com/colour-science/colour-clf-io/discussions>`__\n- `Gitter <https://gitter.im/colour-science/colour>`__\n- `X <https://x.com/colour_science>`__\n- `Bluesky <https://bsky.app/profile/colour-science.bsky.social>`__\n\nAbout\n-----\n\n| **Colour - CLF IO** by Colour Developers\n| Copyright 2024 Colour Developers \u2013 `colour-developers@colour-science.org <colour-developers@colour-science.org>`__\n| This software is released under terms of BSD-3-Clause: https://opensource.org/licenses/BSD-3-Clause\n| `https://github.com/colour-science/colour-clf-io <https://github.com/colour-science/colour-clf-io>`__\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Library to parse and create file in the Common LUT format",
"version": "0.1.1",
"project_urls": null,
"split_keywords": [
"clf",
" color",
" color-science",
" color-space",
" color-spaces",
" colorspace",
" colorspaces",
" colour",
" colour-science",
" colour-space",
" colour-spaces",
" colourspace",
" colourspaces",
" common lut format",
" python"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "2f16bc3a43512fa8426042e06711329c4d061605f2c64dc58234928dfb5dbf9d",
"md5": "4c70ee68fa66c9b861fe04bf367756b6",
"sha256": "5203ddc9706838343d4f48e3b7f66e49e51290bf2eac279facff2a2a80c9a7c4"
},
"downloads": -1,
"filename": "colour_clf_io-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4c70ee68fa66c9b861fe04bf367756b6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.10",
"size": 243754,
"upload_time": "2025-02-12T14:05:57",
"upload_time_iso_8601": "2025-02-12T14:05:57.375982Z",
"url": "https://files.pythonhosted.org/packages/2f/16/bc3a43512fa8426042e06711329c4d061605f2c64dc58234928dfb5dbf9d/colour_clf_io-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1c07e0fe84cc8edc37e42e7e981bf1a7c0d299f40a19a732b37bc9e2fe70b6d8",
"md5": "c01463334e5ee0390877b82c7edb532e",
"sha256": "6f1912cd7248a4d79c2e675fb958503b6818b8f78158d21a411bbacedb8b5438"
},
"downloads": -1,
"filename": "colour_clf_io-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "c01463334e5ee0390877b82c7edb532e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.14,>=3.10",
"size": 326990,
"upload_time": "2025-02-12T14:05:53",
"upload_time_iso_8601": "2025-02-12T14:05:53.841207Z",
"url": "https://files.pythonhosted.org/packages/1c/07/e0fe84cc8edc37e42e7e981bf1a7c0d299f40a19a732b37bc9e2fe70b6d8/colour_clf_io-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-12 14:05:53",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "colour-clf-io"
}
JSON