Skip to main content

Home for board configs

Project description

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.

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

naluconfigs-17.1.1.tar.gz (65.8 kB view details)

Uploaded Source

Built Distribution

naluconfigs-17.1.1-py3-none-any.whl (144.5 kB view details)

Uploaded Python 3

File details

Details for the file naluconfigs-17.1.1.tar.gz.

File metadata

  • Download URL: naluconfigs-17.1.1.tar.gz
  • Upload date:
  • Size: 65.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for naluconfigs-17.1.1.tar.gz
Algorithm Hash digest
SHA256 bdfd28530ebff225110511c4cccd967d4c9dec5d1ed37ee4af0a717b174cfe54
MD5 b6b6f7d48dd23ea40eb892a2b26f498a
BLAKE2b-256 4e65f795413c4a4ddf6000c2dc279657a3e675682fa34bbc6241a047a9ff2820

See more details on using hashes here.

File details

Details for the file naluconfigs-17.1.1-py3-none-any.whl.

File metadata

  • Download URL: naluconfigs-17.1.1-py3-none-any.whl
  • Upload date:
  • Size: 144.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for naluconfigs-17.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a9cfa14454e5f9696290684706429db9c7fb9f83953be7d4858b45a7a0d17a35
MD5 d1fb1d6d3f2416ef4ab3c50b778e7223
BLAKE2b-256 200e19b139f8f6307de7126e96343dd2dffb0e1b2b7145611c217650548343c7

See more details on using hashes here.

Supported by

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