Skip to main content

ichec-brand

ICHEC's brand pack: the logo in every variant, the colours and fonts as design tokens, and the blocks motif from our slide templates. Web apps, diagrams, slides and videos take the brand from here, so they all match ichec.ie and each other. A project's own brand extends this pack from the project's repo.

The ICHEC brand guide says which colour to use for what, and how to use the logo and the blocks.

Use the files

Everything is plain files in brands/ichec/, so any tool can use them:

  • brand.json: the name, the logo and font files, and the tokens, in the W3C design tokens format.
  • logo/: the logo, the logo without its tagline, and the mark, each for light and dark backgrounds, as SVG with a 400 px high PNG beside each.
  • fonts/: Raleway, unmodified, as TTF for desktop tools and WOFF2 for the web, with fonts.css and its licence.
  • blocks/: ready-made blocks patterns as SVG.

Use it from JavaScript

npm install ichec-brand
import {checkBrand, loadBrand} from 'ichec-brand/brand';
import {flatTokens} from 'ichec-brand/tokens';
import {blocksSvg} from 'ichec-brand/blocks';

const t = flatTokens(loadBrand('ichec'));
t['color.role.text'];   // '#08152A'
blocksSvg({cols: 30, rows: 8, edge: 'right', seed: 4});

loadBrand takes ichec, a path, or a package whose target holds a brand.json. It returns the pack merged over the packs it extends, with every file path made absolute. The files are also at node_modules/ichec-brand/brands/ichec/.

To draw a blocks pattern from the command line:

npx ichec-blocks --cols 30 --rows 8 --edge right --seed 4 > blocks.svg

The generator uses a small seeded random number generator, mulberry32, so a port can draw the same patterns.

Use it from Python

pip install ichec-brand

The Python package holds the same brands/ files, from the same release, and no reader. ichec_brand.brands() is the directory of the packs. A Django portal's pack extends ICHEC's with "extends": "ichec-brand/brands/ichec", and ichec-django-core finds the parent in this package. Add ichec-brand to the portal's dependencies.

Extend the brand

A project's brand, such as a portal's or a funded project's, lives in the project's own repo and extends this pack. This repo never holds a project's brand. The project's brand.json names its parent and sets only what differs:

{
  "extends": "ichec-brand/brands/ichec",
  "name": "Example project",
  "logos": {"full": "logo/logo.svg", "fullOnDark": "logo/logo-white.svg"},
  "tokens": {"color": {"role": {"primary": {"$value": "#0F6E75"}}}}
}

Tokens merge key by key, so a role the project doesn't set keeps ICHEC's value. logos, fonts and funding replace the parent's as a whole, so a project never shows ICHEC's mark as its own. A pack with more than one font family lists a licence for each in fonts.licence. Paths are relative to the pack that names them.

A pack can also fill slots that ICHEC leaves empty:

  • wordmark: the name as the logo writes it, where that differs from name, for text drawn like the logo.
  • tagline: one line under the name, on title cards.
  • funding: emblem, a file such as the EU emblem, with the statement, programme and grant that must go beside it.
  • motif: the pattern for backgrounds and banners, blocks or wave-lines. ICHEC's is blocks.
  • social: account names by network, such as {"linkedin": "example"}.
  • extras: other named files that tools may use, such as a backdrop photo.

header and footer say how a page, slide or title card shows the brand. They merge key by key, so a child sets only what differs:

"footer": {
  "logo": null,
  "background": "surface-dark",
  "strapline": "Open access to research facilities",
  "partners": {"label": "Developed by", "logos": [{"name": "ICHEC", "url": "https://www.ichec.ie", "logo": "partners/ichec.svg"}]}
}
  • logo: a key of logos, or null for none.
  • background: a colour role, such as surface-dark.
  • image: a key of extras to show behind it, such as backdrop.
  • strapline: one line of text.
  • partners: logos to show together, with a label and, for each, a name, a logo file and an optional url.

A footer shows funding when the pack has it, so the hints don't repeat it.

Give every logo, emblem and partner logo a PNG with uv run node_modules/ichec-brand/scripts/png_logos.py <pack dir>, and add checkBrand(loadBrand('<pack dir>')) to the project's tests. It checks the colours, text contrast, files and funding, and returns a list of problems.

Develop

npm test                           # tokens, contrast, files and blocks
npm run presets                    # after changing blocks/presets.json
uv run scripts/build_logos.py      # after changing logo/source.svg, then:
uv run scripts/png_logos.py brands/ichec

Metadata

Release files for ichec-brand 0.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for ichec-brand 0.3.0
File Size Uploaded Provenance Actions
ichec_brand-0.3.0.tar.gz 776.8 kB Without provenance Details for ichec_brand-0.3.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for ichec-brand 0.3.0
File Interpreter ABI Platform Actions
ichec_brand-0.3.0-py3-none-any.whl Python 3 none any Details for ichec_brand-0.3.0-py3-none-any.whl

Total release size: 1.6 MB

Release files / ichec_brand-0.3.0.tar.gz

Download URL ichec_brand-0.3.0.tar.gz
Size 776.8 kB
Tags Source
SHA-256 checksum
How to use checksums
597c382ea4de23b1a48941ee2dd0dc7119648b92d75c8b071e4385de70a339fe
BLAKE2b-256 checksum
How to use checksums
bb4e93945dd8346291b4b5b764a978c899c72696cab88d9e6d7e3b7a7f46e53c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Release files / ichec_brand-0.3.0-py3-none-any.whl

Download URL ichec_brand-0.3.0-py3-none-any.whl
Size 780.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
96f33f391601f3b083a98dc2472b5da12f47e5e758955a173a7cf92ab3a24401
BLAKE2b-256 checksum
How to use checksums
f2ba3ec5992092d08fff5e36c700830fffca13d5c388f93c5a9c7239a7017973
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.7

Security for ichec-brand 0.3.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.3.0 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page