Skip to content

Add default labconfig file to docs #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 22, 2021
Merged

Add default labconfig file to docs #80

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ This documentation is primarily for developers who might want to use this common
:hidden:
:caption: DOCUMENTATION

labconfig
api/index

.. toctree::
Expand Down
25 changes: 25 additions & 0 deletions docs/source/labconfig.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
The *labconfig.ini* file
========================

The `labconfig.ini` file is a global configuration file for your **labscript-suite** installation.
It contains configurable settings that govern how the individual components of the suite operate.
The name of this file must be the host computer's system name.
So if my system's name was `heisenberg`, the labconfig file name would be `heisenberg.ini`.
This file should be located in the `labscript-suite` directory in the user space, in the `labconfig` subdirectory.

When :doc:`installing the **labscript-suite** for the first time <labscript-suite:installation/index>`, running the `labscript-profile-create` command will automatically generate the `labscript-suite` user space directory in the correct place and generate a `labconfig.ini` file for use on your system.
By editing the `ini` file named after your system, you can update the configuration settings of your **labscript-suite** installation.

The Default *labconfig.ini*
---------------------------

Below is a copy of the default lab configuration if you were to install the **labscript-suite** today.

.. note::

When updates are made to the suite that add or change keys available in the labconfig, your local file will **NOT** be automatically updated to include them.
Instead, if keys are missing from your local profile, default behavior will be assumed.
To implement the added functionality, you will need to manually add/change the keys in your local labconfig.

.. include:: ../../labscript_profile/default_profile/labconfig/example.ini
:code: