Skip to content
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.

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

[pre-commit.ci] pre-commit autoupdate #44

Merged
merged 16 commits into from
Mar 20, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion .mdl_style.rb
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
exclude_rule 'MD033' # Inline HTML
exclude_rule 'MD034' # Bare URL used
exclude_rule 'MD036' # Emphasis used instead of a header
rule 'MD013', :line_length => 120, :code_blocks => false, :tables => false
rule 'MD013', :line_length => 120, :ignore_code_blocks => true, :tables => false
2 changes: 1 addition & 1 deletion docs/source/data_management/fair_principles.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,4 +126,4 @@ must be well-described to enable replication and/or combination in different set
- **NIH** = National Institutes of Health
- **NOAA** = National Oceanic and Atmospheric Administration

Credit: Content taken from a Confluence guide written by Anne Wilson, and modified by Shawn Polson in 2019
Credit: Content taken from a Confluence guide written by Anne Wilson, and modified by Shawn Polson in 2019
2 changes: 1 addition & 1 deletion docs/source/data_management/file_formats/netcdf.md
Original file line number Diff line number Diff line change
Expand Up @@ -121,4 +121,4 @@ There are two netCDF data models:
* [NetCDF ToolsUI](https://docs.unidata.ucar.edu/netcdf-java/current/userguide/toolsui_ref.html)
* [NetCDF Workshop Materials](https://www.unidata.ucar.edu/software/netcdf/workshops/2011/index.html)

Credit: Content taken from a Confluence guide written by Doug Lindholm
Credit: Content taken from a Confluence guide written by Doug Lindholm
2 changes: 1 addition & 1 deletion docs/source/data_management/metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,4 +166,4 @@ Provenance is often provided as descriptive prose, making machine-readable text
- **LEMR** = LASP Extended Metadata Repository
- **SPASE** = Space Physics Archive Search and Extract

Credit: Content taken from a Confluence guide written by Anne Wilson and Shawn Polson.
Credit: Content taken from a Confluence guide written by Anne Wilson and Shawn Polson.
2 changes: 1 addition & 1 deletion docs/source/licensing.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,4 +87,4 @@ you’re distributing/producing.
* [Choose a license](https://choosealicense.com/)
* [Open Source Initiative (OSI)](https://opensource.org/licenses)
* [The Turing Way overview of licensing](https://the-turing-way.netlify.app/reproducible-research/licensing)
* [Free and Open Source License Comparison chart](https://en.wikipedia.org/wiki/Comparison_of_free_and_open-source_software_licenses)
* [Free and Open Source License Comparison chart](https://en.wikipedia.org/wiki/Comparison_of_free_and_open-source_software_licenses)
2 changes: 1 addition & 1 deletion docs/source/workflows/docker/beginner_guide_to_docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -190,4 +190,4 @@ docker image prune
* **ps** = Process Status
* **tty** = TeleTYpe (terminal)

*Credit: Content taken from a Confluence guide written by Maxine Hartnett*
*Credit: Content taken from a Confluence guide written by Maxine Hartnett*
29 changes: 24 additions & 5 deletions docs/source/workflows/docker/containerizing_idl_with_docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,11 @@ running on the host machine from within the non-IDL container.
In this example a container is created from the official `CentOS` image:

```bash
docker container run -it --name=centos_container --rm -v /var/run/docker.sock:/var/run/docker.sock -v /usr/bin/docker:/usr/bin/docker centos bash
docker container run -it \
--name=centos_container --rm \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /usr/bin/docker:/usr/bin/docker \
centos bash
```

This `docker container run` command generates a CentOS container and initiates an interactive connection to that
Expand Down Expand Up @@ -240,7 +244,12 @@ Now, as in the previous example, spin up a non-IDL container based on the offici
additional bind mount for the newly-created data volume:

```bash
docker container run --rm -it --name=centos_container -v /var/run/docker.sock:/var/run/docker.sock -v /usr/bin/docker:/usr/bin/docker -v SharedData:/src centos bash
docker container run --rm -it \
--name=centos_container \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /usr/bin/docker:/usr/bin/docker \
-v SharedData:/src \
centos bash
```

#### In the Interactive Shell Inside the `CentOS` Container
Expand Down Expand Up @@ -296,7 +305,12 @@ mounted to the `/src` directory in the container.
Now create the non-IDL container named `centos_container`:

```bash
docker container run --rm -it --name=centos_container -v /Users/stmu4541/projects/docker/src:/src -v /var/run/docker.sock:/var/run/docker.sock -v /usr/bin/docker:/usr/bin/docker lentos bash
docker container run --rm -it \
--name=centos_container \
-v /Users/stmu4541/projects/docker/src:/src \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /usr/bin/docker:/usr/bin/docker \
lentos bash
```

Here, `lentos`, which immediately precedes the bash command specifies the official `centos` image.
Expand All @@ -315,7 +329,12 @@ Using a Jenkins-based principal container is not significantly different than th
latest `CentOS` OS.

```bash
docker container run --name=jenkins -v /var/run/docker.sock:/var/run/docker.sock -v /usr/bin/docker:/usr/bin/docker -p 8080:8080 jenkins/jenkins:lts-centos
docker container run \
--name=jenkins \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /usr/bin/docker:/usr/bin/docker \
-p 8080:8080 \
jenkins/jenkins:lts-centos
```

Note that a Dockerfile is not required for this simple example since the container is created from the official `CentOS`
Expand Down Expand Up @@ -418,4 +437,4 @@ docker container run -e DISPLAY=host.docker.internal:0 idlde_image
* **VPN** = Virtual Private Network
* **yum** = Yellowdog Updater, Modified

*Credit: Content taken from a Confluence guide written by Steven Mueller*
*Credit: Content taken from a Confluence guide written by Steven Mueller*
2 changes: 1 addition & 1 deletion docs/source/workflows/docker/docker_compose_examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -359,4 +359,4 @@ And you will need some Flyway migration scripts to build up your DB schema howev
* **apk** = Alpine Package Keeper
* **pip** = Pip Installs Packages

*Credit: Content taken from a Confluence guide written by Gavin Medley and Maxine Hartnett*
*Credit: Content taken from a Confluence guide written by Gavin Medley and Maxine Hartnett*
2 changes: 1 addition & 1 deletion docs/source/workflows/docker/export_display_with_docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,4 +47,4 @@ argument) allows the container access to the host machine X socket.

* [Official Docker documentation](https://docs.docker.com/)

*Credit: Content taken from a Confluence guide written by Steven Mueller*
*Credit: Content taken from a Confluence guide written by Steven Mueller*
2 changes: 1 addition & 1 deletion docs/source/workflows/docker/lasp_docker_registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,4 +167,4 @@ WEBSUPPORT ticket or send an email to `[email protected]`
* **UI** = User Interface
* **URL** = Uniform Resource Locator

*Credit: Content taken from a Confluence guide written by Maxine Hartnett*
*Credit: Content taken from a Confluence guide written by Maxine Hartnett*
7 changes: 5 additions & 2 deletions docs/source/workflows/docker/lasp_image_registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,10 @@ docker pull docker-registry.pdmz.lasp.colorado.edu/tsis/dsinteg2_migration
Or, the following command:

```bash
docker container run --user root --rm -it --name timDevContainer docker-registry.pdmz.lasp.colorado.edu/tsis/dsinteg2_migration bash
docker container run --user root --rm -it \
--name timDevContainer \
docker-registry.pdmz.lasp.colorado.edu/tsis/dsinteg2_migration \
bash
```

This will launch a container based on the registry `dsinteg2_migration` image and connect to that container with a
Expand Down Expand Up @@ -115,4 +118,4 @@ Only the image argument is relevant to the registry pull.
* **TIM** = Total Irradiance Monitor
* **URL** = Uniform Resource Locator

*Credit: Content taken from a Confluence guide written by Steven Mueller*
*Credit: Content taken from a Confluence guide written by Steven Mueller*
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@

## Acronyms

*Credit: Content taken from a Confluence guide written by Steven Mueller*
*Credit: Content taken from a Confluence guide written by Steven Mueller*
13 changes: 8 additions & 5 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"

[tool.poetry]
[project]
name = "developer-guide"
version = "0.1.0"
description = "Guidelines for software developers at LASP"
authors = [
"Matthew Bourque <[email protected]>",
"Keira Brooks <[email protected]>",
"Veronica Martinez <[email protected]>",
"Alex Ware <[email protected]>"]
{name = "Matthew Bourque", email = "[email protected]>"},
{name = "Keira Brooks", email = "[email protected]>"},
{name = "Veronica Martinez", email = "[email protected]>"},
{name = "Alex Ware", email = "[email protected]>"}]
readme = "README.md"
license = "MIT"
keywords = ["LASP", "Developer Guide", "Software"]
Expand All @@ -20,6 +20,9 @@ classifiers = [
"Topic :: Scientific/Engineering",
]

[tool.poetry]
package-mode = false

[tool.poetry.dependencies]
myst-parser = "^3.0.1"
python = ">=3.9,<4"
Expand Down