Skip to content

sdss/cherno

Repository files navigation

cherno

Versions Code style: black Documentation Status Tests Status

SDSS guider actor

Installation

In general you should be able to install cherno by doing

pip install sdss-cherno

To build from source, use

git clone git@github.com:sdss/cherno
cd cherno
pip install .

Development

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

uv sync

Style and type checking

This project uses the black code style with 88-character line lengths for code and docstrings. It is recommended to use ruff for both linting and formatting and the pyproject.toml file contains the appropriate configuration. 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": "charliermarsh.ruff"
  },
  "[markdown]": {
    "editor.wordWrapColumn": 88
  },
  "[restructuredtext]": {
    "editor.wordWrapColumn": 88
  },
  "[json]": {
    "editor.quickSuggestions": {
      "strings": true
    },
    "editor.suggest.insertMode": "replace",
    "editor.formatOnSave": true,
    "editor.defaultFormatter": "esbenp.prettier-vscode",
    "editor.tabSize": 2
  },
  "[yaml]": {
    "editor.insertSpaces": true,
    "editor.formatOnSave": true,
    "editor.tabSize": 2,
    "editor.autoIndent": "advanced",
  },
  "prettier.tabWidth": 2,
  "editor.rulers": [88],
  "editor.wordWrapColumn": 88,
  "python.analysis.typeCheckingMode": "basic",
  "ruff.nativeServer": true
}

This assumes that the Python and Pylance extensions are installed.

About

The SDSS-V guider code

Resources

License

Stars

Watchers

Forks

Contributors 3

  •  
  •  
  •  

Languages