Skip to content

Commit

Permalink
Updates for github repo rename to sunkit-spex. (#129)
Browse files Browse the repository at this point in the history
* Updates for github repo rename to sunkit-spex.
* Small fix for docs build use r-string for some doc strings
  • Loading branch information
samaloney authored Apr 15, 2024
1 parent 01c7e53 commit 2bc79dc
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 10 deletions.
4 changes: 2 additions & 2 deletions .sunpy-template.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ default_context:
author_name: "The SunPy Community"
author_email: "[email protected]"
license: "BSD 3-Clause"
project_url: "https://sunkit_spex.readthedocs.io"
github_repo: "sunpy/sunxspex"
project_url: "https://sunkit-spex.readthedocs.io"
github_repo: "sunpy/sunkit-spex"
minimum_python_version: "3.7"
use_compiled_extensions: "n"
include_example_code: "n"
1 change: 1 addition & 0 deletions changelog/129.trivial.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update references to new repository name `sunkit-spex`.
6 changes: 3 additions & 3 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ build-backend = 'setuptools.build_meta'
enabled = true
verify_pr_number = true
changelog_skip_label = "No Changelog Entry Needed"
help_url = "https://github.com/sunpy/sunxspex/blob/master/changelog/README.rst"
help_url = "https://github.com/sunpy/sunkit-spex/blob/master/changelog/README.rst"

changelog_missing_long = "There isn't a changelog file in this pull request. Please add a changelog file to the `changelog/` directory following the instructions in the changelog [README](https://github.com/sunpy/sunxspex/blob/master/changelog/README.rst."
changelog_missing_long = "There isn't a changelog file in this pull request. Please add a changelog file to the `changelog/` directory following the instructions in the changelog [README](https://github.com/sunpy/sunkit-spex/blob/master/changelog/README.rst."

type_incorrect_long = "The changelog file you added is not one of the allowed types. Please use one of the types described in the changelog [README](https://github.com/sunpy/sunxspex/blob/master/changelog/README.rst)"
type_incorrect_long = "The changelog file you added is not one of the allowed types. Please use one of the types described in the changelog [README](https://github.com/sunpy/sunkit-spex/blob/master/changelog/README.rst)"

number_incorrect_long = "The number in the changelog file you added does not match the number of this pull request. Please rename the file."

Expand Down
10 changes: 5 additions & 5 deletions sunkit_spex/fitting_legacy/likelihoods.py
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ def _check_numbers_left(self, remaining):
return np.sum(remaining)

def gaussian_loglikelihood(self, model_counts, observed_counts, observed_count_errors):
""" Gaussian log-likelihood.
r""" Gaussian log-likelihood.
.. math::
ln(L_{Gauss}) = -\frac{N}{2} ln(2\pi D^{2}) + \frac{1}{2}\Chi^{2}
Expand All @@ -150,7 +150,7 @@ def gaussian_loglikelihood(self, model_counts, observed_counts, observed_count_e
return self._check_numbers_left(self.remove_non_numbers(likelihoods)) # =ln(L)

def chi2(self, model_counts, observed_counts, observed_count_errors):
""" Chi-squared fit statistic.
r""" Chi-squared fit statistic.
.. math::
\Chi^{2} = - (\frac{(D - \mu)^{2}}{\sigma})^{2}
Expand All @@ -173,7 +173,7 @@ def chi2(self, model_counts, observed_counts, observed_count_errors):
return self._check_numbers_left(self.remove_non_numbers(likelihoods))

def poisson_loglikelihood(self, model_counts, observed_counts, observed_count_errors):
""" Poissonian log-likelihood.
r""" Poissonian log-likelihood.
.. math::
ln(L_{Poisson}) = D ln(\mu) - \mu - ln(D!)
Expand All @@ -196,7 +196,7 @@ def poisson_loglikelihood(self, model_counts, observed_counts, observed_count_er
return self._check_numbers_left(self.remove_non_numbers(likelihoods))

def cash_loglikelihood(self, model_counts, observed_counts, observed_count_errors):
""" Cash log-likelihood.
r""" Cash log-likelihood.
A simplification of the poissonian log-likelihood where the independent data term is
neglected. Since the data term is neglected the absolute number does not say much
Expand Down Expand Up @@ -226,7 +226,7 @@ def cash_loglikelihood(self, model_counts, observed_counts, observed_count_error
return self._check_numbers_left(self.remove_non_numbers(likelihoods))

def cstat_loglikelihood(self, model_counts, observed_counts, observed_count_errors):
""" C-stat log-likelihood.
r""" C-stat log-likelihood.
A simplification of the poissonian log-likelihood where the independent data term
is replaced using sterling's approximation. Used in the XSPEC fitting software.
Expand Down

0 comments on commit 2bc79dc

Please sign in to comment.