alpaca-simulators 1.0.0__tar.gz

alpaca_simulators-1.0.0/PKG-INFO

@@ -0,0 +1,105 @@
+Metadata-Version: 2.4
+Name: alpaca-simulators
+Version: 1.0.0
+Summary: Python based ASCOM Alpaca simulators for Observatory Control Software testing
+Keywords: astronomy,astrophysics,telescope
+Author: Peter Pedersen, David Degen
+License-Expression: MIT
+Requires-Dist: fastapi
+Requires-Dist: uvicorn
+Requires-Dist: pyyaml
+Requires-Dist: cabaret
+Requires-Dist: jinja2
+Requires-Dist: python-multipart
+Requires-Dist: pytest ; extra == 'test'
+Requires-Dist: httpx ; extra == 'test'
+Requires-Python: >=3.10
+Project-URL: Bug Tracker, https://github.com/ppp-one/alpaca-simulators/issues
+Project-URL: Homepage, https://github.com/ppp-one/alpaca-simulators
+Project-URL: Source, https://github.com/ppp-one/alpaca-simulators
+Provides-Extra: test
+Description-Content-Type: text/markdown
+
+# ASCOM Alpaca Simulators
+
+A comprehensive simulator for ASCOM Alpaca devices that provides a RESTful API for testing and developing observatory control software.
+
+## Features
+
+- **Complete Device Simulation**: Supports all major ASCOM device types including:
+
+  - Camera
+  - Telescope
+  - Dome
+  - Focuser
+  - Filter Wheel
+  - Rotator
+  - Safety Monitor
+  - Switch
+  - Observing Conditions
+  - Cover Calibrator
+
+- **Realistic Image Generation**: Uses [cabaret](https://github.com/ppp-one/cabaret) to generate authentic astronomical images for camera simulation
+- **RESTful API**: Fully compliant with the ASCOM Alpaca Device API specification
+- **Interactive Test Interface**: Web-based control panel for manual testing
+- **Configurable Devices**: YAML-based configuration for all device properties
+
+## Quick Start
+
+The fastest way to run the simulator is using [uv](https://docs.astral.sh/uv/).
+
+1. **Clone the repository:**
+   ```bash
+   git clone https://github.com/ppp-one/alpaca-simulators
+   cd alpaca-simulators
+   ```
+
+2. **Run the simulator:**
+   ```bash
+   uv run alpaca-simulators
+   ```
+   *This will automatically install dependencies and start the server at `http://0.0.0.0:11111`.*
+
+## Configuration & Options
+
+The simulator supports several command-line arguments:
+
+```bash
+# Run on a different port with auto-reload enabled
+uv run alpaca-simulators --port 8080 --reload
+
+# Use a specific configuration file
+uv run alpaca-simulators --config my_custom_setup.yaml
+```
+
+### Test Interface
+
+The simulator includes a web-based test UI at `http://localhost:11111/test_interface` that allows you to:
+
+- **GET properties**: Retrieve current values from any device property
+- **PUT operations**: Set values and trigger actions using form inputs
+
+
+### Device Configuration
+
+On first run, the simulator generates `src/alpaca_simulators/config/config.yaml` from a template. You can modify this file to set:
+
+- Device names and descriptions
+- Initial property values
+- Capabilities and limits
+- Available options (e.g., filter names, camera properties)
+
+
+### Example API Calls
+
+```bash
+# Get telescope position
+curl http://localhost:11111/api/v1/telescope/0/rightascension
+
+# Set camera exposure time
+curl -X PUT http://localhost:11111/api/v1/camera/0/startexposure \
+  -d "Duration=5.0&Light=true"
+
+# Check if dome is at home
+curl http://localhost:11111/api/v1/dome/0/athome
+```

alpaca_simulators-1.0.0/README.md

@@ -0,0 +1,83 @@
+# ASCOM Alpaca Simulators
+
+A comprehensive simulator for ASCOM Alpaca devices that provides a RESTful API for testing and developing observatory control software.
+
+## Features
+
+- **Complete Device Simulation**: Supports all major ASCOM device types including:
+
+  - Camera
+  - Telescope
+  - Dome
+  - Focuser
+  - Filter Wheel
+  - Rotator
+  - Safety Monitor
+  - Switch
+  - Observing Conditions
+  - Cover Calibrator
+
+- **Realistic Image Generation**: Uses [cabaret](https://github.com/ppp-one/cabaret) to generate authentic astronomical images for camera simulation
+- **RESTful API**: Fully compliant with the ASCOM Alpaca Device API specification
+- **Interactive Test Interface**: Web-based control panel for manual testing
+- **Configurable Devices**: YAML-based configuration for all device properties
+
+## Quick Start
+
+The fastest way to run the simulator is using [uv](https://docs.astral.sh/uv/).
+
+1. **Clone the repository:**
+   ```bash
+   git clone https://github.com/ppp-one/alpaca-simulators
+   cd alpaca-simulators
+   ```
+
+2. **Run the simulator:**
+   ```bash
+   uv run alpaca-simulators
+   ```
+   *This will automatically install dependencies and start the server at `http://0.0.0.0:11111`.*
+
+## Configuration & Options
+
+The simulator supports several command-line arguments:
+
+```bash
+# Run on a different port with auto-reload enabled
+uv run alpaca-simulators --port 8080 --reload
+
+# Use a specific configuration file
+uv run alpaca-simulators --config my_custom_setup.yaml
+```
+
+### Test Interface
+
+The simulator includes a web-based test UI at `http://localhost:11111/test_interface` that allows you to:
+
+- **GET properties**: Retrieve current values from any device property
+- **PUT operations**: Set values and trigger actions using form inputs
+
+
+### Device Configuration
+
+On first run, the simulator generates `src/alpaca_simulators/config/config.yaml` from a template. You can modify this file to set:
+
+- Device names and descriptions
+- Initial property values
+- Capabilities and limits
+- Available options (e.g., filter names, camera properties)
+
+
+### Example API Calls
+
+```bash
+# Get telescope position
+curl http://localhost:11111/api/v1/telescope/0/rightascension
+
+# Set camera exposure time
+curl -X PUT http://localhost:11111/api/v1/camera/0/startexposure \
+  -d "Duration=5.0&Light=true"
+
+# Check if dome is at home
+curl http://localhost:11111/api/v1/dome/0/athome
+```

alpaca_simulators-1.0.0/pyproject.toml

@@ -0,0 +1,59 @@
+[build-system]
+build-backend = "uv_build"
+requires = ["uv_build>=0.8.14,<0.9.0"]
+
+[dependency-groups]
+dev = [
+  "ruff",
+  "pre-commit",
+  "pytest",
+  "httpx"
+]
+
+[project]
+authors = [
+  {name = "Peter Pedersen"},
+  {name = "David Degen"}
+]
+dependencies = [
+  "fastapi",
+  "uvicorn",
+  "pyyaml",
+  "cabaret",
+  "jinja2",
+  "python-multipart"
+]
+description = "Python based ASCOM Alpaca simulators for Observatory Control Software testing"
+keywords = ["astronomy", "astrophysics", "telescope"]
+license = "MIT"
+name = "alpaca-simulators"
+readme = "README.md"
+requires-python = ">=3.10"
+version = "1.0.0"
+
+[project.optional-dependencies]
+test = ["pytest", "httpx"]
+
+[project.scripts]
+alpaca-simulators = "alpaca_simulators.run_simulator:main"
+
+[project.urls]
+"Bug Tracker" = "https://github.com/ppp-one/alpaca-simulators/issues"
+Homepage = "https://github.com/ppp-one/alpaca-simulators"
+Source = "https://github.com/ppp-one/alpaca-simulators"
+
+[tool.ruff]
+exclude = ["uv.lock", "*.yaml"]
+extend-include = ["*.ipynb"]
+line-length = 99
+
+[tool.ruff.lint]
+fixable = ["ALL"]
+select = ["E", "F", "I001", "UP"]
+
+[tool.uv.build-backend]
+data = [
+  "src/alpaca_simulators/config/"
+]
+module-name = "alpaca_simulators"
+source-include = ["src/alpaca_simulators/config/default.yaml"]

alpaca_simulators-1.0.0/src/alpaca_simulators/__init__.py

@@ -0,0 +1,3 @@
+from alpaca_simulators.config import Config
+
+__all__ = ["Config"]

alpaca_simulators-1.0.0/src/alpaca_simulators/api/__init__.py

@@ -0,0 +1 @@
+# API package init file