https://github.com/uasal/config_um
Configuration Repository for Ultra-Marine.
https://github.com/uasal/config_um
configuration-files python-package support-data version-control
Last synced: 5 months ago
JSON representation
Configuration Repository for Ultra-Marine.
- Host: GitHub
- URL: https://github.com/uasal/config_um
- Owner: uasal
- License: gpl-3.0
- Created: 2025-03-05T17:56:51.000Z (about 1 year ago)
- Default Branch: develop
- Last Pushed: 2026-01-10T05:36:55.000Z (5 months ago)
- Last Synced: 2026-01-11T01:39:02.843Z (5 months ago)
- Topics: configuration-files, python-package, support-data, version-control
- Language: Python
- Homepage:
- Size: 2.47 MB
- Stars: 0
- Watchers: 12
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Copyright: COPYRIGHT
Awesome Lists containing this project
README
# config_um
Ultra-Marine repository for support data and configuration management files to be installable as a python package.
The [main](https://github.com/uasal/config_um/tree/main) branch of this repo is under change control. The [develop](https://github.com/uasal/config_um/tree/develop) branch is currently the default to enable rapid development of systems engineering budgets but the default will be changed to main once baseline observatory design is frozen. Changes to [main](https://github.com/uasal/config_um/tree/main) require code owner approval, changes to the [develop](https://github.com/uasal/config_um/tree/develop) branch require approval of two other team members.
Details on the change control process are found in the [coronograph design documentation repository](https://github.com/uasal/spacecoron_design_docs) currently but maybe moved. Refer to [Teledocs](https://teledocs.space) if the previous link does not work to see if an entry there has been made for the change control process documentation.
This repository contains reference data for the observatory and telescope. The data in the repository is intended to encapsulate all parameters which represent the high-level system and are to be identical when called by the the various tools/simulators. This includes details of the telescope optical system, such as coatings and sensors, and observatory properties such as slew times.
The parameters for each subsystem are found in the `configs` directory. A description of how configurations are used in UASAL software, users can find an example notebook in the `docs` directory of the [config_project_template](https://github.com/uasal/config_project_template) repository. The example demonstrates how to load the TOML parameter files in a Python script. TOML files are human readable configuration files that can be read with a range of parsers https://github.com/toml-lang/toml/wiki.
## Configuration Management
Refer to the [UASAL Configuration Management Summary](https://github.com/uasal/lab_documents/blob/main/computing/development_guide/configuration_management.md) for additionally details on how analysis, simulation tools, and configuration repositories are structured within the UASAL GitHub organization.
For Configuration FAQ's, also defer to the [UASAL Configuration Management Summary](https://github.com/uasal/lab_documents/blob/main/computing/development_guide/configuration_management.md) for more information.
------------
## Dependencies
`config_um` is dependent on [utils_config](https://github.com/uasal/utils_config) but will be automatically installed.
## Installation
ssh keys are required for the pip-based install. Verify you have ssh keys installed in GitHub, or check out this [ssh key tutorial](https://github.com/uasal/lab_documents/blob/main/ssh_key_tutorial.md)
### Pip-based install
```sh
pip install git+ssh://git@github.com/uasal/config_um.git
```
### Installed via cloning
```sh
git clone git@github.com:uasal/config_um.git
cd config_um
pip install .
```
## Usage
config_um makes usage of the ConfigLoader class (as *config_loader*) from utils_config via the `load_config_values` method, which accepts 'raw' 'parsed' or 'unitless' as an argument, returning a dictionary after parsing the 'configs' directory for .toml filies
```python
import config_um
data = config_um.load_config_values()
print(data["observatory"]["pointing"]["jitter_rms"])
```
load_config_values() has a default argument of 'raw' or alternatively pass in one of the three viable arguments for how values should be presented:
- `load_config_values('unitless')` -> 0.01
- `load_config_values('parsed')` -> {'value': 0.01, 'unit': 'arcsecond'}
- `load_config_values('raw')` -> 10e-3arcsecond
For importing data and keeping code consistent across installs, config_um will return the path to support_data with `get_data_path()`
```python
import config_um
data_path = config_um.get_data_path()
print(data_path)
```
## Astropy Unit Validation
All .toml config values should have a valid astropy unit if any units are defined. If no unit is included, the value is assumed to be unitless. A GitHub CI will automatically run a test on push to validate astropy units in the configs, reporting any issues with non-conforming astropy units. If you'd like to perform validation locally, you may run `pytest tests/test_configs.py` from the root directory of the repo. Alternatively in your python environment you may run the following snippit:
```python
import config_um
config_um.load_config_values("parsed", return_loader=True).validate_astropy()
```
Which will return 'True' if every unit is a valid astropy unit, or a list containing every invalid unit. If you would like to use a custom u
nit, click [here](https://docs.astropy.org/en/stable/units/combining_and_defining.html#defining-units) for how to define that as a custom unit in Astropy.
## Git large file storage (LFS)
This repository makes use of the git large file storage for files listed in the `.gitattributes` file.
Accessing these files will require users having (Git Large File Storage (LFS))[https://docs.github.com/en/repositories/working-with-files/managing-large-files/installing-git-large-file-storage] installed on their local machine.
If you have Git LFS installed, then the large files will be pulled by default.
This can be disabled in your gitconfig, as described (at this link)[https://stackoverflow.com/questions/42019529/how-to-clone-pull-a-git-repository-ignoring-lfs].