Data

Tools

Indexes

Applications

Experiments

Open Source Science

gold

Gold is a containerized environment for working on provably correct software

https://github.com/jhwohlgemuth/gold

Science Score: 26.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.3%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Gold is a containerized environment for working on provably correct software

Basic Info
  • Host: GitHub
  • Owner: jhwohlgemuth
  • License: mit
  • Language: Shell
  • Default Branch: main
  • Size: 262 KB
Statistics
  • Stars: 0
  • Watchers: 2
  • Forks: 2
  • Open Issues: 1
  • Releases: 0
Created over 2 years ago · Last pushed 11 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation Security

README.md

🏅 Gold  

CodeFactor Code Size

Gold is a containerized environment for working on provably correct software and more

Quick Start

Use VS Code in the browser in Three Easy Steps™

  1. Install Docker or Podman
  2. Run the command 1 shell docker run -it \ --privileged \ --name notebook \ --hostname $(hostname) \ -p 1337:1337 \ ghcr.io/jhwohlgemuth/gold
  3. Open a browser and navigate to https://localhost:1337 2

[!TIP] See Container Customization section for more details on how to customize the container.

What is Gold?

🚧 UNDER CONSTRUCTION

So what, big deal, who cares?

🚧 UNDER CONSTRUCTION

Things you can do with Gold

[!TIP] See the examples directory for details on all the things you can do with Gold.

  • Write, run, and debug Rocq code from within a browser-based instance of VSCode 3
  • Work with modern Rust-based projects to write provably correct software
  • Spin up feature-rich development environments for use from a terminal or browser-based IDE 3
  • Work with WebAssembly
  • Quickly and easily compare multiple languages using interative notebooks
  • 🚧 UNDER CONSTRUCTION

Container Customization

[!NOTE] Use install_extensions to install VS Code extensions.

[!NOTE] install_extensions accepts any number of image names (see Image Design section)
Example install_extensions development python rust

The following environment variables are available to customize containers: - CODE_SERVER_CONFIG: Location of code-server server configuration file (within container) - Default: /app/code-server/config/config.yaml - CODE_SERVER_PORT: Port to use for code-server server - Default: 1337 - CODE_SERVER_PASSWORD: Password to use for code-server server - Default: password - JUPYTER_CONFIG: Location of code-server server configuration file (within container) - Default: /root/.jupyter/jupyter_notebook_config.py - JUPYTER_PORT: Port to use for Jupyter server - Default: 13337 - JUPYTER_PASSWORD_HASH: Password to use for Jupyter server - Default: password

[!TIP] Change environment variables with the --env parameter 4 (ex. docker run -it --env CODE_SERVER_PORT=8080 <image>)

Architecture

[!TIP] See ARCHITECTURE.md

Contributing

[!TIP] See CONTRIBUTING.md

Alt

Footnotes

[1]

--privileged is required to use Apptainer within the container

[2]

The default code-server port can be changed with the CODE_SERVER_PORT environment variable. See the Container Customization section for more details.

[3]

See code-server project

[4]

See docker run documentation

Owner

  • Name: Jason Wohlgemuth
  • Login: jhwohlgemuth
  • Kind: user
  • Location: Knoxville, TN
  • Company: Oak Ridge National Laboratory

GitHub Events

Total
  • Push event: 30
  • Create event: 1
  • Commit comment event: 6
Last Year
  • Push event: 30
  • Create event: 1
  • Commit comment event: 6

Issues and Pull Requests

Last synced: about 1 year ago

All Time
  • Total issues: 2
  • Total pull requests: 3
  • Average time to close issues: about 5 hours
  • Average time to close pull requests: 1 day
  • Total issue authors: 2
  • Total pull request authors: 3
  • Average comments per issue: 0.0
  • Average comments per pull request: 0.67
  • Merged pull requests: 3
  • Bot issues: 1
  • Bot pull requests: 1
Past Year
  • Issues: 1
  • Pull requests: 2
  • Average time to close issues: about 5 hours
  • Average time to close pull requests: 39 minutes
  • Issue authors: 1
  • Pull request authors: 2
  • Average comments per issue: 0.0
  • Average comments per pull request: 1.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • audcarson (1)
  • renovate[bot] (1)
Pull Request Authors
  • audcarson (2)
  • step-security-bot (2)
  • renovate[bot] (2)
Top Labels
Issue Labels
Pull Request Labels
documentation (2) enhancement (2)

Dependencies

.github/actions/build-and-push-image/action.yml actions
  • Dockerfile * docker
.github/workflows/dev.yml actions
  • ./.github/actions/build-and-push-image * composite
  • actions/checkout v1 composite
  • actions/checkout v3 composite
  • docker/login-action 65b78e6e13532edd9afa3aa52ac7964289d1a9c1 composite
.github/workflows/gold.yml actions
  • ./.github/actions/build-and-push-image * composite
  • actions/checkout v1 composite
  • actions/checkout v3 composite
  • docker/login-action 65b78e6e13532edd9afa3aa52ac7964289d1a9c1 composite
.github/workflows/notebook.yml actions
  • ./.github/actions/build-and-push-image * composite
  • actions/checkout v1 composite
  • actions/checkout v3 composite
  • docker/login-action 65b78e6e13532edd9afa3aa52ac7964289d1a9c1 composite
.github/workflows/prune.yml actions
  • vlaurin/action-ghcr-prune v0.5.0 composite
.github/workflows/rust.yml actions
  • ./.github/actions/build-and-push-image * composite
  • actions/checkout v1 composite
  • actions/checkout v3 composite
  • docker/login-action 65b78e6e13532edd9afa3aa52ac7964289d1a9c1 composite
.github/workflows/web.yml actions
  • ./.github/actions/build-and-push-image * composite
  • actions/checkout v1 composite
  • actions/checkout v3 composite
  • docker/login-action 65b78e6e13532edd9afa3aa52ac7964289d1a9c1 composite
.github/actions/build-and-push-image/Dockerfile docker
  • debian bullseye-slim build
Dockerfile docker
  • ghcr.io/jhwohlgemuth/rust latest build
provision/scripts/dev/Brewfile homebrew
  • jandedobbeleer/oh-my-posh/oh-my-posh *
  • pipx *
  • pixi *
  • pkgxdev/made/pkgx *
  • uv *
config/jupyter/environment.yml pypi
  • ipyflow *
  • ipyparallel *
  • jupyter_contrib_nbextensions *
  • mitosheet *