Skip to content

Commit 6bed9a6

Browse files
Anselmoosourcery-ai[bot]Copilot
authored
fix: correct spelling of SpectraFit (#2102)
* chore: Refactor code structure for improved readability and maintainability * fix: Update repository links to use consistent casing for SpectraFit * Update docs/changelogs/v0.x.x.md Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com> * Update docs/changelogs/v0.x.x.md Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com> * Update README.md Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com> * Update README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * Update docs/changelogs/v0.x.x.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: sourcery-ai[bot] <58596630+sourcery-ai[bot]@users.noreply.github.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent 919440d commit 6bed9a6

12 files changed

Lines changed: 440 additions & 251 deletions

File tree

.devcontainer/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This folder contains the configuration for the SpectraFit development container,
1919

2020
### Option 2: Using GitHub Codespaces
2121

22-
1. Go to the [SpectraFit repository](https://github.com/Anselmoo/spectrafit)
22+
1. Go to the [SpectraFit repository](https://github.com/Anselmoo/SpectraFit)
2323
2. Click the green "Code" button
2424
3. Select "Codespaces" tab
2525
4. Click "Create codespace on main"
@@ -140,7 +140,7 @@ To change post-creation setup steps, edit `.devcontainer/setup.sh`:
140140

141141
- [VS Code Dev Containers Documentation](https://code.visualstudio.com/docs/devcontainers/containers)
142142
- [Dev Container Features](https://containers.dev/features)
143-
- [SpectraFit Documentation](https://anselmoo.github.io/spectrafit/)
143+
- [SpectraFit Documentation](https://anselmoo.github.io/SpectraFit/)
144144
- [uv Documentation](https://docs.astral.sh/uv/)
145145

146146
## 🤝 Contributing

.github/pull_request_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
- [ ] Have you followed the guidelines in our Contributing document?
66
- [ ] Have you checked to ensure there aren't other open
7-
[Pull Requests](https://github.com/Anselmoo/spectrafit/pulls) for the same
7+
[Pull Requests](https://github.com/Anselmoo/SpectraFit/pulls) for the same
88
update/change?
99

1010
<!-- You can erase any parts of this template not applicable to your Pull Request. -->

CHANGELOG.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ All notable changes to this project will be documented in this file.
105105

106106
### :package: Full Changelog
107107

108-
**Full Changelog**: https://github.com/Anselmoo/spectrafit/compare/v1.3.0...v1.4.0
108+
**Full Changelog**: https://github.com/Anselmoo/SpectraFit/compare/v1.3.0...v1.4.0
109109

110110
### :gear: Who Contributes
111111

@@ -157,7 +157,7 @@ All notable changes to this project will be documented in this file.
157157

158158
### :package: Full Changelog
159159

160-
**Full Changelog**: https://github.com/Anselmoo/spectrafit/compare/v1.2.2...v1.3.0
160+
**Full Changelog**: https://github.com/Anselmoo/SpectraFit/compare/v1.2.2...v1.3.0
161161

162162
### :gear: Who Contributes
163163

@@ -229,7 +229,7 @@ All notable changes to this project will be documented in this file.
229229

230230
### :package: Full Changelog
231231

232-
**Full Changelog**: https://github.com/Anselmoo/spectrafit/compare/v1.2.1...v1.2.2
232+
**Full Changelog**: https://github.com/Anselmoo/SpectraFit/compare/v1.2.1...v1.2.2
233233

234234
### :gear: Who Contributes
235235

@@ -295,7 +295,7 @@ All notable changes to this project will be documented in this file.
295295

296296
### :package: Full Changelog
297297

298-
**Full Changelog**: https://github.com/Anselmoo/spectrafit/compare/v1.2.0...v1.2.1
298+
**Full Changelog**: https://github.com/Anselmoo/SpectraFit/compare/v1.2.0...v1.2.1
299299

300300
### :gear: Who Contributes
301301

@@ -415,7 +415,7 @@ All notable changes to this project will be documented in this file.
415415

416416
### :package: Full Changelog
417417

418-
**Full Changelog**: https://github.com/Anselmoo/spectrafit/compare/v1.1.0...v1.2.0
418+
**Full Changelog**: https://github.com/Anselmoo/SpectraFit/compare/v1.1.0...v1.2.0
419419

420420
### :gear: Who Contributes
421421

@@ -562,7 +562,7 @@ All notable changes to this project will be documented in this file.
562562
### :package: Full Changelog
563563

564564
**Full Changelog**:
565-
https://github.com/Anselmoo/spectrafit/compare/v1.0.5...v1.1.0
565+
https://github.com/Anselmoo/SpectraFit/compare/v1.0.5...v1.1.0
566566

567567
### :gear: Who Contributes
568568

@@ -646,7 +646,7 @@ https://github.com/Anselmoo/spectrafit/compare/v1.0.5...v1.1.0
646646
### :package: Full Changelog
647647

648648
**Full Changelog**:
649-
https://github.com/Anselmoo/spectrafit/compare/v1.0.4...v1.0.5
649+
https://github.com/Anselmoo/SpectraFit/compare/v1.0.4...v1.0.5
650650

651651
### :gear: Who Contributes
652652

@@ -787,7 +787,7 @@ https://github.com/Anselmoo/spectrafit/compare/v1.0.4...v1.0.5
787787
### :package: Full Changelog
788788

789789
**Full Changelog**:
790-
https://github.com/Anselmoo/spectrafit/compare/v1.0.3.post2...v1.0.4
790+
https://github.com/Anselmoo/SpectraFit/compare/v1.0.3.post2...v1.0.4
791791

792792
### :gear: Who Contributes
793793

@@ -820,7 +820,7 @@ https://github.com/Anselmoo/spectrafit/compare/v1.0.3.post2...v1.0.4
820820
### :package: Full Changelog
821821

822822
**Full Changelog**:
823-
https://github.com/Anselmoo/spectrafit/compare/v1.0.3.post1...v1.0.4
823+
https://github.com/Anselmoo/SpectraFit/compare/v1.0.3.post1...v1.0.4
824824

825825
### :gear: Who Contributes
826826

@@ -853,7 +853,7 @@ https://github.com/Anselmoo/spectrafit/compare/v1.0.3.post1...v1.0.4
853853
### :package: Full Changelog
854854

855855
**Full Changelog**:
856-
https://github.com/Anselmoo/spectrafit/compare/v1.0.3.post0...v1.0.4
856+
https://github.com/Anselmoo/SpectraFit/compare/v1.0.3.post0...v1.0.4
857857

858858
### :gear: Who Contributes
859859

@@ -883,7 +883,7 @@ https://github.com/Anselmoo/spectrafit/compare/v1.0.3.post0...v1.0.4
883883
### :package: Full Changelog
884884

885885
**Full Changelog**:
886-
https://github.com/Anselmoo/spectrafit/compare/v1.0.3...v1.0.4
886+
https://github.com/Anselmoo/SpectraFit/compare/v1.0.3...v1.0.4
887887

888888
### :gear: Who Contributes
889889

@@ -905,7 +905,7 @@ https://github.com/Anselmoo/spectrafit/compare/v1.0.3...v1.0.4
905905
### :package: Full Changelog
906906

907907
**Full Changelog**:
908-
https://github.com/Anselmoo/spectrafit/compare/v1.0.2...v1.0.3
908+
https://github.com/Anselmoo/SpectraFit/compare/v1.0.2...v1.0.3
909909

910910
### :gear: Who Contributes
911911

@@ -1041,7 +1041,7 @@ https://github.com/Anselmoo/spectrafit/compare/v1.0.2...v1.0.3
10411041
### :package: Full Changelog
10421042

10431043
**Full Changelog**:
1044-
https://github.com/Anselmoo/spectrafit/compare/v1.0.1...v1.0.2
1044+
https://github.com/Anselmoo/SpectraFit/compare/v1.0.1...v1.0.2
10451045

10461046
### :gear: Who Contributes
10471047

@@ -1253,7 +1253,7 @@ https://github.com/Anselmoo/spectrafit/compare/v1.0.1...v1.0.2
12531253
### :package: Full Changelog
12541254

12551255
**Full Changelog**:
1256-
https://github.com/Anselmoo/spectrafit/compare/v1.0.0.post1...v1.1.0
1256+
https://github.com/Anselmoo/SpectraFit/compare/v1.0.0.post1...v1.1.0
12571257

12581258
### :gear: Who Contributes
12591259

@@ -1283,7 +1283,7 @@ https://github.com/Anselmoo/spectrafit/compare/v1.0.0.post1...v1.1.0
12831283
### :package: Full Changelog
12841284

12851285
**Full Changelog**:
1286-
https://github.com/Anselmoo/spectrafit/compare/v1.0.0.post0...v1.0.1
1286+
https://github.com/Anselmoo/SpectraFit/compare/v1.0.0.post0...v1.0.1
12871287

12881288
### :gear: Who Contributes
12891289

@@ -1415,7 +1415,7 @@ https://github.com/Anselmoo/spectrafit/compare/v1.0.0.post0...v1.0.1
14151415
### :package: Full Changelog
14161416

14171417
**Full Changelog**:
1418-
https://github.com/Anselmoo/spectrafit/compare/v1.0.0...v1.1.0
1418+
https://github.com/Anselmoo/SpectraFit/compare/v1.0.0...v1.1.0
14191419

14201420
### :gear: Who Contributes
14211421

@@ -1453,7 +1453,7 @@ https://github.com/Anselmoo/spectrafit/compare/v1.0.0...v1.1.0
14531453
### :package: Full Changelog
14541454

14551455
**Full Changelog**:
1456-
https://github.com/Anselmoo/spectrafit/compare/v0.22.9...v0.22.10
1456+
https://github.com/Anselmoo/SpectraFit/compare/v0.22.9...v0.22.10
14571457

14581458
### :gear: Who Contributes
14591459

CONTRIBUTING.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@ help this project `SpectraFit`.
2121

2222
Here are some important resources:
2323

24-
- [Issues](https://github.com/Anselmoo/spectrafit/issues) for open BUG reports
24+
- [Issues](https://github.com/Anselmoo/SpectraFit/issues) for open BUG reports
2525
or feature requests
26-
- [Pull requests](https://github.com/Anselmoo/spectrafit/pulls) for contributing
26+
- [Pull requests](https://github.com/Anselmoo/SpectraFit/pulls) for contributing
2727
code
2828
- Milestones, which are listed below.
2929

@@ -124,7 +124,7 @@ The footer should contain any information about **Breaking Changes** and is also
124124

125125
## Milestones
126126

127-
[Milestones][10] now also available for the `spectrafit` application.
127+
[Milestones][10] now also available for the `SpectraFit` application.
128128
Furthermore, project status can be seen in the [GitHub Project Panel][13].
129129

130130
## Testing
@@ -178,7 +178,7 @@ readability:
178178

179179
This template is adapted from [opengovernment][3].
180180

181-
[1]: https://github.com/Anselmoo/spectrafit/actions
181+
[1]: https://github.com/Anselmoo/SpectraFit/actions
182182
[2]: https://google.github.io/styleguide/pyguide.html
183183
[3]: https://github.com/opengovernment/opengovernment/blob/main/CONTRIBUTING.md
184184
[4]: https://github.com/astral-sh/uv
@@ -189,9 +189,9 @@ This template is adapted from [opengovernment][3].
189189
<!-- trunk-ignore(markdownlint/MD053) -->
190190

191191
[8]: https://lmfit.github.io/lmfit-py/fitting.html
192-
[9]: https://github.com/Anselmoo/spectrafit/pulls
193-
[10]: https://github.com/Anselmoo/spectrafit/milestones
194-
[11]: https://github.com/Anselmoo/spectrafit/issues
192+
[9]: https://github.com/Anselmoo/SpectraFit/pulls
193+
[10]: https://github.com/Anselmoo/SpectraFit/milestones
194+
[11]: https://github.com/Anselmoo/SpectraFit/issues
195195
[12]: https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue
196-
[13]: https://github.com/Anselmoo/spectrafit/projects/1
196+
[13]: https://github.com/Anselmoo/SpectraFit/projects/1
197197
[14]: https://www.conventionalcommits.org/

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
[![CI - Python Package](https://github.com/Anselmoo/spectrafit/actions/workflows/python-ci.yml/badge.svg?branch=main)](https://github.com/Anselmoo/spectrafit/actions/workflows/python-ci.yml)
2-
[![codecov](https://codecov.io/gh/Anselmoo/spectrafit/branch/main/graph/badge.svg?token=pNIMKwWsO2)](https://codecov.io/gh/Anselmoo/spectrafit)
3-
[![PyPI](https://img.shields.io/pypi/v/spectrafit?logo=PyPi&logoColor=yellow)](https://pypi.org/project/spectrafit/)
1+
[![CI - Python Package](https://github.com/Anselmoo/SpectraFit/actions/workflows/python-ci.yml/badge.svg?branch=main)](https://github.com/Anselmoo/SpectraFit/actions/workflows/python-ci.yml)
2+
[![codecov](https://codecov.io/gh/Anselmoo/SpectraFit/branch/main/graph/badge.svg?token=pNIMKwWsO2)](https://codecov.io/gh/Anselmoo/SpectraFit)
3+
[![PyPI](https://img.shields.io/pypi/v/SpectraFit?logo=PyPi&logoColor=yellow)](https://pypi.org/project/SpectraFit/)
44
[![Conda](https://img.shields.io/conda/v/conda-forge/spectrafit?label=Anaconda.org&logo=anaconda)](https://github.com/conda-forge/spectrafit-feedstock)
5-
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/spectrafit?color=gree&logo=Python&logoColor=yellow)](https://pypi.org/project/spectrafit/)
6-
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Anselmoo/spectrafit/main.svg)](https://results.pre-commit.ci/latest/github/Anselmoo/spectrafit/main)
5+
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/SpectraFit?color=green&logo=Python&logoColor=yellow)](https://pypi.org/project/SpectraFit/)
6+
[![pre-commit.ci status](https://results.pre-commit.ci/badge/github/Anselmoo/SpectraFit/main.svg)](https://results.pre-commit.ci/latest/github/Anselmoo/SpectraFit/main)
77
[![doi](https://img.shields.io/badge/10.1021/acsomega.3c09262-blue?logo=DOI&logoColor=white)](https://pubs.acs.org/doi/full/10.1021/acsomega.3c09262)
88

99
<p align="center">
@@ -48,27 +48,27 @@ scientific applications.
4848
via pip:
4949

5050
```bash
51-
pip install spectrafit
51+
pip install SpectraFit
5252

5353
# with support for Jupyter Notebook
5454

55-
pip install spectrafit[jupyter]
55+
pip install SpectraFit[jupyter]
5656

5757
# with support for the dashboard in the Jupyter Notebook
5858

59-
pip install spectrafit[jupyter-dash]
59+
pip install SpectraFit[jupyter-dash]
6060

6161
# with support to visualize pkl-files as graph
6262

63-
pip install spectrafit[graph]
63+
pip install SpectraFit[graph]
6464

6565
# with all upcomming features
6666

67-
pip install spectrafit[all]
67+
pip install SpectraFit[all]
6868

6969
# Upgrade
7070

71-
pip install spectrafit --upgrade
71+
pip install SpectraFit --upgrade
7272
```
7373

7474
via conda, see also
@@ -248,7 +248,7 @@ Which results in the following output:
248248
249249
## Documentation
250250
251-
Please see the [extended documentation](https://anselmoo.github.io/spectrafit/)
251+
Please see the [extended documentation](https://anselmoo.github.io/SpectraFit/)
252252
for the full usage of `SpectraFit`.
253253
254254
The documentation is generated by

SECURITY.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,14 +33,14 @@ possible.
3333
> Current Python vulnerabilities can be found at the [:link:GitHub's Advisory
3434
> Database][10]. See also: [:link:GitHub's Security Lab][11].
3535
36-
[1]: https://github.com/Anselmoo/spectrafit/
37-
[2]: https://github.com/Anselmoo/spectrafit/releases
36+
[1]: https://github.com/Anselmoo/SpectraFit/
37+
[2]: https://github.com/Anselmoo/SpectraFit/releases
3838
[3]: https://securitylab.github.com/tools/codeql/
3939
[4]: https://synk.io/
4040
[5]: https://sonarcloud.io/
4141
[6]: https://github.com/dependabot
4242
[7]: https://pre-commit.com/
4343
[8]: https://codecov.io/
44-
[9]: https://github.com/Anselmoo/spectrafit/issues/new/choose
44+
[9]: https://github.com/Anselmoo/SpectraFit/issues/new/choose
4545
[10]: https://github.com/advisories?query=type%3Areviewed+ecosystem%3Apip
4646
[11]: https://securitylab.github.com/

0 commit comments

Comments
 (0)