archon

A library and actor to communicate with an STA Archon controller.

Installation

In general you should be able to install archon by doing

pip install sdss-archon

To build from source, use

git clone [email protected]:sdss/archon
cd archon
pip install .

Docker

The actor can run as a Docker container; new images for main (pointing to tag latest) and tags are created via a GitHub Action. The images are stored in the GitHub Container Registry. To pull the latest image run

docker pull ghcr.io/sdss/archon:latest

To run a container

docker run --name archon --rm --detach --network host ghcr.io/sdss/archon:latest

This assumes that RabbitMQ is running on the default port in the host computer and that the Archon controllers are accessible over the host network.

Development

archon uses poetry for dependency management and packaging. To work with an editable install it's recommended that you setup poetry and install archon in a virtual environment by doing

poetry install

Or in editable mode

pip install -e .

Note that the latter will only install the production dependencies, not the development ones. You'll need to install those manually (see pyproject.toml [tool.poetry.dev-dependencies]).

Style and type checking

This project uses the black code style with 88-character line lengths for code and docstrings. It is recommended that you run black on save. Imports must be sorted using isort. The GitHub test workflow checks all the Python file to make sure they comply with the black formatting.

Linting uses flake8 and isort rules implemented using ruff.

For Visual Studio Code, the following project file is compatible with the project configuration:

{
  "[python]": {
    "editor.formatOnSave": true,
    "editor.codeActionsOnSave": {
      "source.fixAll": "explicit",
      "source.organizeImports.ruff": "explicit"
    },
    "editor.wordWrap": "off",
    "editor.tabSize": 4,
    "editor.defaultFormatter": "ms-python.black-formatter"
  },
  "[markdown]": {
    "editor.wordWrapColumn": 88
  },
  "[restructuredtext]": {
    "editor.wordWrapColumn": 88
  },
  "[json]": {
    "editor.quickSuggestions": {
      "strings": true
    },
    "editor.suggest.insertMode": "replace",
    "gitlens.codeLens.scopes": ["document"],
    "editor.formatOnSave": true,
    "editor.defaultFormatter": "esbenp.prettier-vscode",
    "editor.tabSize": 2
  },
  "[yaml]": {
    "editor.insertSpaces": true,
    "editor.formatOnSave": true,
    "editor.tabSize": 2,
    "editor.autoIndent": "advanced",
    "gitlens.codeLens.scopes": ["document"]
  },
  "prettier.tabWidth": 2,
  "editor.rulers": [88],
  "editor.wordWrapColumn": 88,
  "python.analysis.typeCheckingMode": "basic"
}

This assumes that the Python and Pylance extensions are installed.

This project uses type hints.