Skip to content

Revise installation method and add contributing section #27

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.

Sign up for GitHub

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

Merged
jessecusack merged 1 commit into from
Oct 9, 2025
Merged

Revise installation method and add contributing section #27

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 11 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,10 @@ Additionally, we provide the following intermediate processing outputs that may

## Installation

Use pip:
Use pipx:

```bash
pip install git+https://github.com/OSUGliders/glide
pipx install git+https://github.com/OSUGliders/glide
```

## Usage
Expand Down Expand Up @@ -59,7 +59,7 @@ To extract the valid or interpolated location data into a CSV file
glide gps glidername.l2.nc -o glidername.gps.csv
```

## Quality controls
## Quality control

We currently apply the following QC during L1 -> L2 processing:

Expand Down Expand Up @@ -101,3 +101,11 @@ uv run glide --log-level=debug l2 tests/data/osu684.sbd.csv tests/data/osu684.tb
```

By default this will produce a file `slocum.l2.nc`.

## Contributing

Thank you for your interest in contributing to this project. Collaboration is highly encouraged, and contributions from the community are always welcome. To ensure a productive and respectful development process, please follow these guidelines.

Before submitting any code, please open an issue to describe the problem you're addressing or the feature you'd like to implement. This allows for discussion around the proposed changes, helps align efforts, and ensures that contributions are in line with the project's goals. When creating an issue, be as detailed as possible. Include relevant context, your motivation, and any initial ideas you may have.

Once an issue has been discussed and agreed upon, feel free to fork the repository and begin working on a solution in a separate branch. When you're ready, submit a pull request that references the related issue and clearly outlines the changes you've made. Try to keep your pull requests focused and limited to a single concern to make the review process smoother. Please ensure your code follows the existing style and structure of the project. If you're unsure about conventions or need guidance, don't hesitate to ask. Contributions should be well-tested.