Add fit status fields to output container of MuonIntensityFitter

[jstvdk]

Added field for the storing information about muon intensity fit convergence.
Related issue #2359

[maxnoe]

Could you add a test for the new fields?

This could be simply checking

assert result.is_valid
assert not result.parameters_at_limit
assert np.isfinite(result.likelihood_value)

in one of the tests for now

[maxnoe]

The only thing missing now is a changelog entry.

You can add one by creating a file docs/changes/2381.feature.rst (the number of this PR + the category of the change) adding a small description mentioning the new fields.

[maxnoe]

Looks good! Thank you very much.

The pre-commit check is complaining about some style issues.

To prevent that in the future, you can locally run pre-commit install

After that, you can now run to fix it for this PR:

pre-commit run --files $(git diff origin/main --name-only)

[jstvdk]

To prevent that in the future, you can locally run pre-commit install

After that, you can now run to fix it for this PR:

pre-commit run --files $(git diff origin/main --name-only)

Thank you for the explanation

[maxnoe]

@jstvdk The correction for the style issues is still missing, that's all I guess.

Need any help with fixing those?

[jstvdk]

@jstvdk The correction for the style issues is still missing, that's all I guess.

Need any help with fixing those?

Yes please, I didn't understand this completely.

[maxnoe]

Yes please, I didn't understand this completely.

The CI runs the same checks you can run locally. What is currently failing is the check for the style guide, which can be solved by auto-formatting the code using the pre-commit config and committing the result.

Here you can see the error:
https://github.com/cta-observatory/ctapipe/actions/runs/5531696637/jobs/10093041566

To fix them, you can run:

pre-commit run --files $(git diff origin/main --name-only)

And then add / commit the changes and push

[jstvdk]

To fix them, you can run:

pre-commit run --files $(git diff origin/main --name-only)

And then add / commit the changes and push

Thanks, I tried this solution, but it is not changing and pushing, because "Everything is up-to-date".

[maxnoe]

Ah, sorry, I forgot that you are working on a fork.

You need to compare to the main branch in this repository. Assuming you have it added as upstream, e.g. via:

git remote add upstream https://github.com/cta-observatory/ctapipe

To update and check:

git fetch upstream
git diff upstream/main --name-only

Then run with upstream instead of origin:

pre-commit run --files $(git diff upstream/main --name-only)

[jstvdk]

Then run with upstream instead of origin:

Thank you, I made it.

[maxnoe]

Ah, another issue is that your branch is behind the current main here in the repo, to fix that, you can do:

git fetch upstream
git merge upstream/main

and then running the pre-commit command should work.

[Tobychev]

Is is very hard to change this test so it checks that the likelihood is reasonably close to a known value?

[maxnoe]

Testing a particular value will be hard, yes. Maybe testing that the value is lower for a fit with the correct ring parameters passed in than for one where we don't have ring center / radius values?