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 Replication) 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 Usage 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.3.0.tar.gz (22.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

polarstar-0.3.0-py3-none-any.whl (21.6 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for polarstar-0.3.0.tar.gz
Algorithm Hash digest
SHA256 20090b5123122602e4bd38445af1ebde535089b5fcdba37b24666197ef615ba0
MD5 4bf0fd466dd478249f8955df65737bf5
BLAKE2b-256 0aacbc0c45b5a450016871aa3384399d4b0bb460c57ac09a549328d2b407dee3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: polarstar-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 21.6 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.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a978034a324cbeb49df451cac5695efb5145fb7938242d0bb1c26349000c4011
MD5 1c6b3760c7991ba9eb287932f72862b3
BLAKE2b-256 6aa8557b0198ce3371180623c4fd4616b83d02cacf0c1a269e83d3948267f3f3

See more details on using hashes here.

Supported by

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