NaluConfigs
This repository houses all board configuration files (both register files and clock files).
Installation
Generally you don't have to install this repository unless you plan to change anything.
If you do however want to install this package, the best way is to use our PyPI package:
pip install naluconfigs
Developer Installation
To install this reposity for development the best way is to clone and install as an editable package.
First clone this repository to a suitable location:
git clone https://github.com/NaluScientific/naluconfigs.git
Then install the package into your Anaconda environment:
cd naluconfigs
pip install -e .
Usage
In addition to the default board configuration files and clock files, the naluconfigs package
also contains functions to load or copy these files. Check out the package to see what you can do!
Developers
Install this package as editable, and with development extras:
cd naluconfigs
pip install -e .[dev]
Make sure to read the YAML HELP.md file if you're new, or haven't kept up with NaluConfigs.
This project follows a X.Y.Z version scheme according to the following:
- Add/remove register files, increment X
- register adds / remove, increment Y
- register edits and/or value edits increment Z
Pre-commit
This project uses pre-commit hooks to make sure the code is following the style guide. To install the pre-commit hooks, run the following command:
pre-commit install
The hooks will run automatically when you commit changes to the repository.
The code MUST run the pre-commit hooks before commiting. If the hooks fail, the commit will be rejected.
Tests
The tests are located under the naluconfigs/tests/ directory, and use pytest.
To run the tests, run naluconfigs/run_tests.bat. This will run the tests and also generate a coverage report to
naluconfigs/coverage.xml.
Make sure to keep the test coverage at 100%. This is doable, since NaluConfigs is a relatively simple package. The Coverage Gutters extension is highly recommended to monitor test coverage.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file naluconfigs-18.2.1.tar.gz.
File metadata
- Download URL: naluconfigs-18.2.1.tar.gz
- Upload date:
- Size: 72.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
52ee822fa76ee7784b1d550dc942beba75f2410341b644c82184cf4c7ddad4dc
|
|
| MD5 |
505fbae810e5e5d71e28a3563d31e378
|
|
| BLAKE2b-256 |
340b8314d00f09d9bfd2f0b1983321453c4124286ceaa8ce0e49a032a75c933a
|
File details
Details for the file naluconfigs-18.2.1-py3-none-any.whl.
File metadata
- Download URL: naluconfigs-18.2.1-py3-none-any.whl
- Upload date:
- Size: 158.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
88cd1effafa40fa8b7bf59446ca0b59709645f73b9eca714b740628115b319e4
|
|
| MD5 |
a6075c9b318c0cfe1d4fbbe1792919ed
|
|
| BLAKE2b-256 |
b2f0832903793611fcd77d0b8d83dc12beb88961759643622383628ac23de87c
|
