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

Workcell manager #5

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
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
12 changes: 6 additions & 6 deletions .devcontainer/DevContainer.Dockerfile
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Note: You can use any Debian/Ubuntu based image you want.
FROM mcr.microsoft.com/devcontainers/base:bullseye

# [Optional] Uncomment this section to install additional OS packages.
RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
&& apt-get -y install --no-install-recommends vim
# Note: You can use any Debian/Ubuntu based image you want.
FROM mcr.microsoft.com/devcontainers/base:bullseye
# [Optional] Uncomment this section to install additional OS packages.
RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
&& apt-get -y install --no-install-recommends vim
48 changes: 24 additions & 24 deletions .devcontainer/devcontainer.compose.yaml
Original file line number Diff line number Diff line change
@@ -1,24 +1,24 @@
services:
dev:
build:
context: .
dockerfile: DevContainer.Dockerfile

volumes:
# Forwards the local Docker socket to the container.
- /var/run/docker.sock:/var/run/docker-host.sock
# Update this to wherever you want VS Code to mount the folder of your project
- ../..:/workspaces:cached

# Overrides default command so things don't shut down after the process ends.
entrypoint: /usr/local/share/docker-init.sh
command: sleep infinity

# Uncomment the next four lines if you will use a ptrace-based debuggers like C++, Go, and Rust.
# cap_add:
# - SYS_PTRACE
# security_opt:
# - seccomp:unconfined

# Use "forwardPorts" in **devcontainer.json** to forward an app port locally.
# (Adding the "ports" property to this file will not forward from a Codespace.)
services:
dev:
build:
context: .
dockerfile: DevContainer.Dockerfile
volumes:
# Forwards the local Docker socket to the container.
- /var/run/docker.sock:/var/run/docker-host.sock
# Update this to wherever you want VS Code to mount the folder of your project
- ../..:/workspaces:cached
# Overrides default command so things don't shut down after the process ends.
entrypoint: /usr/local/share/docker-init.sh
command: sleep infinity
# Uncomment the next four lines if you will use a ptrace-based debuggers like C++, Go, and Rust.
# cap_add:
# - SYS_PTRACE
# security_opt:
# - seccomp:unconfined
# Use "forwardPorts" in **devcontainer.json** to forward an app port locally.
# (Adding the "ports" property to this file will not forward from a Codespace.)
106 changes: 53 additions & 53 deletions .devcontainer/devcontainer.json
Original file line number Diff line number Diff line change
@@ -1,53 +1,53 @@
{
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/templates/tree/main/src/docker-outside-of-docker-compose
"name": "MADSci Dev Container",
"dockerComposeFile": "devcontainer.compose.yaml",
"service": "dev",
"workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",

// Use this environment variable if you need to bind mount your local source code into a new container.
"remoteEnv": {
"LOCAL_WORKSPACE_FOLDER": "${localWorkspaceFolder}"
},

"customizations": {
"vscode": {
"extensions": [
"ms-python.python",
"donjayamanne.python-environment-manager",
"charliermarsh.ruff",
"VisualStudioExptTeam.vscodeintellicode",
"aaron-bond.better-comments",
"vuetifyjs.vuetify-vscode",
"christian-kohler.path-intellisense",
"nefrob.vscode-just",
"Vue.volar",
"redhat.vscode-yaml",
"KevinRose.vsc-python-indent",
"ms-python.vscode-pylance",
"ms-toolsai.jupyter"
]
}
},

"features": {
"ghcr.io/devcontainers/features/docker-outside-of-docker:1": {},
"ghcr.io/devcontainers/features/python:1": {},
"ghcr.io/guiyomh/features/just:0": {},
"ghcr.io/devcontainers-extra/features/act:1": {},
"ghcr.io/devcontainers-extra/features/actionlint:1": {},
"ghcr.io/devcontainers-extra/features/pdm:2": {},
"ghcr.io/devcontainers-extra/features/vue-cli:2": {},
"ghcr.io/devcontainers-extra/features/pre-commit:2": {},
"ghcr.io/devcontainers-extra/features/ruff:1": {}
},
// Use 'forwardPorts' to make a list of ports inside the container available locally.
// "forwardPorts": [8000],

// Use 'postCreateCommand' to run commands after the container is created.
"postCreateCommand": "just init"

// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
// "remoteUser": "root"
}
{
// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/templates/tree/main/src/docker-outside-of-docker-compose
"name": "MADSci Dev Container",
"dockerComposeFile": "devcontainer.compose.yaml",
"service": "dev",
"workspaceFolder": "/workspaces/${localWorkspaceFolderBasename}",
// Use this environment variable if you need to bind mount your local source code into a new container.
"remoteEnv": {
"LOCAL_WORKSPACE_FOLDER": "${localWorkspaceFolder}"
},
"customizations": {
"vscode": {
"extensions": [
"ms-python.python",
"donjayamanne.python-environment-manager",
"charliermarsh.ruff",
"VisualStudioExptTeam.vscodeintellicode",
"aaron-bond.better-comments",
// "vuetifyjs.vuetify-vscode",
"christian-kohler.path-intellisense",
"nefrob.vscode-just",
// "Vue.volar",
"redhat.vscode-yaml",
"KevinRose.vsc-python-indent",
"ms-python.vscode-pylance",
"ms-toolsai.jupyter"
]
}
},
"features": {
"ghcr.io/devcontainers/features/docker-outside-of-docker:1": {},
"ghcr.io/devcontainers/features/python:1": {},
"ghcr.io/guiyomh/features/just:0": {},
"ghcr.io/devcontainers-extra/features/act:1": {},
"ghcr.io/devcontainers-extra/features/actionlint:1": {},
"ghcr.io/devcontainers-extra/features/pdm:2": {},
// "ghcr.io/devcontainers-extra/features/vue-cli:2": {},
"ghcr.io/devcontainers-extra/features/pre-commit:2": {},
"ghcr.io/devcontainers-extra/features/ruff:1": {}
},
// Use 'forwardPorts' to make a list of ports inside the container available locally.
// "forwardPorts": [8000],
// Use 'postCreateCommand' to run commands after the container is created.
"postCreateCommand": "just init"
// Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
// "remoteUser": "root"
}
2 changes: 1 addition & 1 deletion .dockerignore
Original file line number Diff line number Diff line change
@@ -1 +1 @@
**/node_modules
**/node_modules
24 changes: 12 additions & 12 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for more information:
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
# https://containers.dev/guide/dependabot

version: 2
updates:
- package-ecosystem: "devcontainers"
directory: "/"
schedule:
interval: weekly
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for more information:
# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
# https://containers.dev/guide/dependabot
version: 2
updates:
- package-ecosystem: "devcontainers"
directory: "/"
schedule:
interval: weekly
82 changes: 41 additions & 41 deletions .justfile
Original file line number Diff line number Diff line change
@@ -1,41 +1,41 @@
# List available commands
default:
@just --list --justfile {{justfile()}}

# initialize the project
init: hooks
@which pdm || echo "pdm not found, you'll need to install it: https://github.com/pdm-project/pdm"
@pdm install
@#test -e .env || cp .env.example .env

# Install the pre-commit hooks
hooks:
@pre-commit install

# Run the pre-commit checks
checks:
@pre-commit run --all-files || { echo "Checking fixes\n" ; pre-commit run --all-files; }
check: checks


# Python tasks

# Update the pdm version
pdm-update:
@pdm self update

# Install the default dependencies
pdm-install:
@pdm install

# Install a specific group of dependencies
pdm-install-group group:
@pdm install --group {{group}}

# Install all dependencies
pdm-install-all:
@just pdm-install-group :all

# Build the python package
pdm-build:
@pdm build
# List available commands
default:
@just --list --justfile {{justfile()}}
# initialize the project
init: hooks
@which pdm || echo "pdm not found, you'll need to install it: https://github.com/pdm-project/pdm"
@pdm install
@#test -e .env || cp .env.example .env
# Install the pre-commit hooks
hooks:
@pre-commit install
# Run the pre-commit checks
checks:
@pre-commit run --all-files || { echo "Checking fixes\n" ; pre-commit run --all-files; }
check: checks
# Python tasks
# Update the pdm version
pdm-update:
@pdm self update
# Install the default dependencies
pdm-install:
@pdm install
# Install a specific group of dependencies
pdm-install-group group:
@pdm install --group {{group}}
# Install all dependencies
pdm-install-all:
@just pdm-install-group :all
# Build the python package
pdm-build:
@pdm build
58 changes: 29 additions & 29 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,29 +1,29 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v5.0.0
hooks:
- id: check-yaml
- id: check-toml
- id: check-ast
- id: check-merge-conflict
- id: check-added-large-files
- id: mixed-line-ending
- id: end-of-file-fixer
- id: trailing-whitespace
- repo: https://github.com/kynan/nbstripout
rev: 0.8.1
hooks:
- id: nbstripout
- repo: https://github.com/astral-sh/ruff-pre-commit
# Ruff version.
rev: v0.8.1
hooks:
# Run the linter.
- id: ruff
args: [--fix]
# Run the formatter.
- id: ruff-format
- repo: https://gitlab.com/bmares/check-json5
rev: v1.0.0
hooks:
- id: check-json5
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v5.0.0
hooks:
- id: check-yaml
- id: check-toml
- id: check-ast
- id: check-merge-conflict
- id: check-added-large-files
- id: mixed-line-ending
- id: end-of-file-fixer
- id: trailing-whitespace
- repo: https://github.com/kynan/nbstripout
rev: 0.8.1
hooks:
- id: nbstripout
- repo: https://github.com/astral-sh/ruff-pre-commit
# Ruff version.
rev: v0.8.1
hooks:
# Run the linter.
- id: ruff
args: [--fix]
# Run the formatter.
- id: ruff-format
- repo: https://gitlab.com/bmares/check-json5
rev: v1.0.0
hooks:
- id: check-json5
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
# Modular Autonomous Discovery for Science (MADSci)

## Overview

MADSci is a modular, autonomous, and scalable framework for scientific discovery and experimentation.

## Components

- [Squid](./src/madsci.squid/README.md): The Workcell Management Engine.
- [Types](./src/madsci.types/README.md): The Type Definition Library for MADSci.
- [PyClient](./src/madsci.pyclient/README.md): The Python Client for MADSci.
- [Module](./src/madsci.module/README.md): The Module Library for integrating devices.
- [Server](./src/madsci.server/README.md): The REST API Server.
- [CLI](./src/madsci.cli/README.md): The Command Line Interface.
- [Dashboard](./src/madsci.dashboard/README.md): The web-based Dashboard and management interface.
- [Resources](./src/madsci.resources/README.md): The Resource Library for managing resources.
- [Events](./src/madsci.events/README.md): The Event Library for managing events.
# Modular Autonomous Discovery for Science (MADSci)
## Overview
MADSci is a modular, autonomous, and scalable framework for scientific discovery and experimentation.
## Components
- [Squid](./src/madsci.squid/README.md): The Workcell Management Engine.
- [Types](./src/madsci.types/README.md): The Type Definition Library for MADSci.
- [PyClient](./src/madsci.pyclient/README.md): The Python Client for MADSci.
- [Module](./src/madsci.module/README.md): The Module Library for integrating devices.
- [Server](./src/madsci.server/README.md): The REST API Server.
- [CLI](./src/madsci.cli/README.md): The Command Line Interface.
- [Dashboard](./src/madsci.dashboard/README.md): The web-based Dashboard and management interface.
- [Resources](./src/madsci.resources/README.md): The Resource Library for managing resources.
- [Events](./src/madsci.events/README.md): The Event Library for managing events.
2 changes: 1 addition & 1 deletion madsci/madsci_client/madsci/client/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
"""The Modular Autonomous Discovery for Science (MADSci) Python Client and CLI."""
"""The Modular Autonomous Discovery for Science (MADSci) Python Client and CLI."""
Loading