Skip to content

adesnik-lab/holochat

Repository files navigation

holochat logo

HoloChat Server

A "modern" stim message server to facilitate communication between rig computers.

ci workflow codecov

Installation

Easy mode install

Just install and call from the commandline without cloning the repo.

conda create -n holochat python pip
conda activate holochat
pip install git+https://github.com/willyh101/holochat.git

Then you can immediately run the server with holochat run.

Install via venv and pip

If you have a python >3.10 on your system, you can install the package directly from github and use venv. I'm assuming you've already cloned the repo.

python3 -m venv .venv
source .venv/bin/activate
pip install -e '.[dev]'

Install via conda

You can also install using conda/mamba to manage python. Just install the most recent python version, whatever version comes up (that's >=3.10).

conda create -n holochat python pip
conda activate holochat
pip install -e '.[dev]'

Usage

Settings File

The settings file is a json file that contains generic settings for the server.

Settings can live in either the project directory or in the user's home directory. The settings file in the user's home directory will take precedence over the one in the repo directory.

In order to generate the settings file, run holochat setup. This generates the settings file in the repo. If you want it in your home directory, use holochat setup --home. To overwrite the settings file in your home directory (or in the repo) use --ow flag.

Running the server

holochat run, the server will load the settings file automatically and run. If this gives you trouble, try python -m holochat

API documentation (aka GET, POST, DELETE) is available at http://[your-local-ip]:8000/docs.

About

simple RESTful communication server for holography experiments

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •