Skip to main content

Polar Star

Project description

Polar Star

PyPI Status Python Version License

Documentation Status Tests Codecov

pre-commit Black

Overview

POLAR (Platform for Optical Laboratory Automation and Research) and STAR (Scientific Tools for Automation and Research) are designed to facilitate the automation and control of experiments in scientific research, with a special focus on optical experiments.

  • POLAR is a hardware platform that enables precise control and automation in optical laboratories, supporting high-throughput experimentation and analysis.
  • STAR is a Python library that provides tools for automation, data collection, and analysis, designed to work seamlessly with POLAR or as a standalone solution for general scientific research.

POLAR: Platform for Optical Laboratory Automation and Research

POLAR is a modular hardware platform created for automating optical experiments, providing researchers with control over spectrometers, sensors, and other lab equipment. It supports precise positioning and integration of various optical instruments, making it ideal for high-throughput spectroscopy, photonics, and related experiments.

Key Features

  • Precision Positioning: Integrates with CNC systems to allow for precise control of sample positioning.
  • Optical Experimentation: Compatible with multiple optical sensors and devices, such as spectrometers and light sources.
  • Modular Design: Easily integrates with a wide range of optical devices and equipment.
  • Automation Support: Enables automated, high-throughput experimental setups.

Getting Started with POLAR

To use POLAR, you can set up the equipment and connect it to STAR for data collection and control.


STAR: Scientific Tools for Automation and Research

STAR is a Python library focused on simplifying the automation of scientific experiments, including data collection and hardware control. While STAR is designed to integrate with POLAR, it can also be used independently for various scientific applications.

Features

  • Automated Data Collection: Simplifies gathering and processing data from different lab instruments.
  • Hardware Control: Provides interfaces to control lab equipment, including spectrometers and CNC machines.
  • Scalable and Modular: STAR’s design supports multiple scientific disciplines beyond optical experiments.

Requirements

  • Python 3.8 or newer
  • Additional dependencies listed in pyproject.toml

Installation

You can install Polar Star via pip from PyPI:

$ pip install polarstar

Usage

Please see the Command-line Reference for details.

Contributing

Contributions are very welcome. To learn more, see the Contributor Guide.

License

Distributed under the terms of the GPL 3.0 license, Polar Star is free and open source software.

Issues

If you encounter any problems, please file an issue along with a detailed description.

Credits

This project was generated from @cjolowicz's Hypermodern Python Cookiecutter template.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

polarstar-0.2.0.tar.gz (20.3 kB view details)

Uploaded Source

Built Distribution

polarstar-0.2.0-py3-none-any.whl (20.2 kB view details)

Uploaded Python 3

File details

Details for the file polarstar-0.2.0.tar.gz.

File metadata

  • Download URL: polarstar-0.2.0.tar.gz
  • Upload date:
  • Size: 20.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for polarstar-0.2.0.tar.gz
Algorithm Hash digest
SHA256 1ef67fc36474562e61fc053caeeffa1b1c089d0fc6358664fd4e14292bc6d8e3
MD5 8047b62c55685db12c747d86ed79a182
BLAKE2b-256 008c61d3493948e942a9054ca56e8e7abdd9a80b7320388c0871258ef96fce90

See more details on using hashes here.

File details

Details for the file polarstar-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: polarstar-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 20.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for polarstar-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 eb263a6b53e941400c4124368ab56155f0c401a38fcf7c8842cbfaf0a44fa359
MD5 74feae95504bcab17fc304191fb140f2
BLAKE2b-256 bc358b32f11b223719a85bfc2fc09aebd59e6c1d3dee440f27263dd83d2b1de4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page