Skip to content

PR: Update Tutorial #1350

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Conversation

laraPPr
Copy link

@laraPPr laraPPr commented May 29, 2025

Summary

In this pr there are updates to the index page of the documentation. I went through all the examples with colour-science 0.4.6. A number of the examples did not work or had different results. I just started using the project so I'm not sure if there is a problem with my installation or if the documentation is not up to date.

the graph that I generated with the code line 1843 looked different. The graph that I generated looked like this. I could not find in the repository where I could replace the images.
image

The graph that I generated with code in line 1852 also looked different. The graph that I generated looked like this. I could not find in the repository where I could replace the images.
unknown

I also maid changes to the pyproject.toml file becaus the feature in line 192 requires numpy 2. I am using 1.26 and hit the an error that it did not know trapezoid which is added to numpy 2. This was changed in the following pr f0958f2 in the colour-science repo.

Preflight

Code Style and Quality

  • Unit tests have been implemented and passed.
  • Pyright static checking has been run and passed.
  • Pre-commit hooks have been run and passed.
  • New transformations have been added to the Automatic Colour Conversion Graph.
  • New transformations have been exported to the relevant namespaces, e.g. colour, colour.models.

Documentation

  • New features are documented along with examples if relevant.
  • The documentation is Sphinx and numpydoc compliant.

laraPPr and others added 3 commits May 29, 2025 15:00
`colour.msds_cmfs_anomalous_trichromacy_Machado2009()` requires numpy 2 since changes in colour-science@f0958f2
@KelSolaar KelSolaar changed the title Update tutorial PR: Update Tutorial Jun 1, 2025
@KelSolaar
Copy link
Member

Hi @laraPPr,

Thank you for the contribution. The images for the docs are automatically generated by this Github Action: https://github.com/colour-science/colour/blob/develop/.github/workflows/continuous-integration-documentation.yml that runs this script under the hood: https://github.com/colour-science/colour/blob/develop/utilities/generate_plots.py

Good catch for np.trapezoid, we might revert this back to np.trapz for now because we need to support Numpy 1.2x for a few months still: https://scientific-python.org/specs/spec-0000/

I might not be able to merge this PR entirely but I will cherry-pick some of its bits.

Cheers,

Thomas

@laraPPr
Copy link
Author

laraPPr commented Jun 2, 2025

Thank you. I will have a closer look at the workflow. Some values were synificantly of from the once in the documentation. Does this indicate that there might be a problem with my installation? I can open a seperate issue on that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants