Skip to content

Commit 5348e03

Browse files
committed
Spelling Kelp-O-Matic consistently
1 parent 9a0301a commit 5348e03

File tree

4 files changed

+18
-28
lines changed

4 files changed

+18
-28
lines changed

docs/faqs.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -11,23 +11,23 @@ Nvidia CUDA-compatible GPU that will make things run faster, but it's not requir
1111

1212
**What resolution should my data be?**
1313

14-
Kelp-o-Matic was designed to work best on imagery with 1cm to 10cm pixel resolution. 5cm resolution is likely optimal.
14+
Kelp-O-Matic was designed to work best on imagery with 1cm to 10cm pixel resolution. 5cm resolution is likely optimal.
1515

1616
**When I run the tool, it starts giving me warnings. Should I worry?**
1717

1818
The warnings are there to give you optional suggestions or hints about things that might be non-optimal. You don't need
1919
to worry about them, but by reading them and making the suggested adjustments, you may find processing to proceed more
2020
quickly.
2121

22-
**Will Kelp-o-Matic work for my data, which is not from western North America?**
22+
**Will Kelp-O-Matic work for my data, which is not from western North America?**
2323

24-
While Kelp-o-Matic was trained primarily on data from British Columbia and California, it has shown good performance in
24+
While Kelp-O-Matic was trained primarily on data from British Columbia and California, it has shown good performance in
2525
other regions like Alaska and Patagonia. The model may work best with imagery similar to our training data, but we
2626
actively work to improve its performance across different geographical areas. If you find the model isn't performing
2727
well with your data, please contact us - we're interested in expanding the model's capabilities and may be able to
2828
optimize it for your specific region.
2929

30-
**Will Kelp-o-Matic work better on my images if I pass in sensor band X for instead of e.g. the red band?**
30+
**Will Kelp-O-Matic work better on my images if I pass in sensor band X for instead of e.g. the red band?**
3131

3232
Most likely no, this won't work. The model is specifically trained to use the relationships between the RGB (and NIR,
3333
for certain models) bands to determine if kelp/mussels are present.

docs/index.md

+7-17
Original file line numberDiff line numberDiff line change
@@ -25,12 +25,8 @@
2525

2626
## Getting Started
2727

28-
Please see the [Beginner Guide](beginner_guide/index.md) if you are new to Anaconda and command line
29-
tools.
30-
31-
If you have worked with Anaconda before, start with the more
32-
brief [installation instructions](installation.md), followed by the documentation for
33-
the [CLI](cli.md) or [Python API](python_lib.md).
28+
Please see the [beginner guide](beginner_guide/index.md) if you are new to using command line tools. Otherwise, see the
29+
[installation](installation.md) and the [CLI](cli.md) or [Python API](python_lib.md) documentation.
3430

3531
## Features
3632

@@ -42,26 +38,20 @@ the [CLI](cli.md) or [Python API](python_lib.md).
4238

4339
## Contribute
4440

45-
Please file a bug report using our
46-
[GitHub Issue Tracker :material-github:](https://github.com/HakaiInstitute/kelp-o-matic/issues) if
47-
you encounter any problems.
41+
Please file a bug report using our
42+
[GitHub Issue Tracker :material-github:](https://github.com/HakaiInstitute/kelp-o-matic/issues) if you encounter any
43+
problems.
4844

4945
Comments and questions are also appreciated!
5046

5147
## License
5248

53-
Kelp-O-Matic is released under
54-
the [MIT license](https://raw.githubusercontent.com/tayden/kelp-o-matic/main/LICENSE.txt).
49+
Kelp-O-Matic is released under the
50+
[MIT license](https://raw.githubusercontent.com/tayden/kelp-o-matic/main/LICENSE.txt).
5551

5652
## Contact
5753

5854
This project was co-created at the [Hakai Institute](https://hakai.org) by:
5955

6056
- [**Taylor Denouden**](mailto:taylor.denouden@hakai.org) *(Machine Learning, Software Development)*
6157
- [**Luba Reshitnyk**](mailto:luba.reshitnyk@hakai.org) *(Scientific Application, Data Collation and Labelling)*
62-
63-
[//]: # (<div style="margin-top: 50px; overflow: hidden; display: flex; justify-content:center; gap:10px;">)
64-
65-
[//]: # (<img alt="Hakai" src="./images/hakai_logo.png" width="50%" />)
66-
67-
[//]: # (</div>)

docs/installation.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Requirements
44

5-
Kelp-o-Matic is currently available for Python versions 3.10 through 3.13.
5+
Kelp-O-Matic is currently available for Python versions 3.10 through 3.13.
66

77
## Quick Install
88

@@ -25,7 +25,7 @@ Kelp-o-Matic is currently available for Python versions 3.10 through 3.13.
2525

2626
## Recommended Installation (Virtual Environment)
2727

28-
It is recommended to install Kelp-o-Matic in a virtual environment to avoid conflicts
28+
It is recommended to install Kelp-O-Matic in a virtual environment to avoid conflicts
2929
with other Python packages present on your system. `uv` is our recommended environment manager
3030
(a faster alternative to `venv`/`virtualenv`), but you can use any Python environment manager you prefer.
3131

@@ -50,7 +50,7 @@ with other Python packages present on your system. `uv` is our recommended envir
5050
source kom-env/bin/activate
5151
```
5252

53-
4. Install Kelp-o-Matic and its dependencies
53+
4. Install Kelp-O-Matic and its dependencies
5454

5555
```bash
5656
uv pip install kelp-o-matic
@@ -63,15 +63,15 @@ with other Python packages present on your system. `uv` is our recommended envir
6363
```
6464

6565
It will deactivate automatically when you close the terminal. To reactivate, just run `source kom-env/bin/activate`
66-
(you don't have to reinstall Kelp-o-Matic though).
66+
(you don't have to reinstall Kelp-O-Matic though).
6767
6868
!!! important
6969
7070
The `kom` command will be available only when the virtual environment is activated.
7171
7272
## Verify Installation
7373
74-
To verify that Kelp-o-Matic was installed correctly and to check the installed version, run:
74+
To verify that Kelp-O-Matic was installed correctly and to check the installed version, run:
7575
7676
```bash
7777
kom --version
@@ -91,7 +91,7 @@ We follow [semantic versioning](https://semver.org/). Regular updates are recomm
9191
- New features
9292
- Security patches
9393
94-
To update Kelp-o-Matic, you can use the following commands:
94+
To update Kelp-O-Matic, you can use the following commands:
9595
9696
=== "PIP"
9797

kelp_o_matic/cli.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ def find_mussels(
141141

142142
def version_callback(value: bool) -> None:
143143
if value:
144-
typer.echo(f"Kelp-o-Matic {__version__}")
144+
typer.echo(f"Kelp-O-Matic {__version__}")
145145
raise typer.Exit()
146146

147147

0 commit comments

Comments
 (0)