najaeda
najaeda is a Python package for loading, elaborating, navigating, editing, and analysing hardware designs from gate-level Verilog netlists to large SystemVerilog RTL cores.
from najaeda import netlist
# Load a gate-level Verilog design with a Liberty standard-cell library
netlist.load_liberty(['NangateOpenCellLibrary.lib'])
top = netlist.load_gate_level_verilog('my_design.v')
# Navigate the hierarchy
for inst in top.get_child_instances():
print(f'{inst.get_name()} → {inst.get_model_name()}')
# Flat connectivity across hierarchy boundaries
for iterm in top.get_term('clk').get_equipotential().get_inst_terms():
print(iterm)
# Edit: rename, reconnect, delete
top.get_net('old_name').set_name('new_name')What you can do
Load gate-level Verilog netlists and elaborate supported Verilog/SystemVerilog RTL, with or without Liberty standard-cell libraries
Navigate hierarchy, nets, and ports at any level of detail — instance-by-instance or flat via equipotentials
Edit netlists: rename instances and nets, disconnect and reconnect signals, delete logic
Analyse designs with the visitor API and export results to pandas for further processing or visualisation
Installation
pip install najaedaFor the optional schematic viewer, run pip install "najaeda[schematic]". In a notebook, use from najaeda.schematic import show; show() to display the currently loaded design.
Requires Python 3.10 or later. Pre-built wheels are published for:
Linux x86_64 and AArch64 (manylinux_2_28; glibc 2.28 or later)
macOS Apple Silicon (arm64), macOS 11 or later
Windows x86_64
Building from a checkout
Initialize the submodules, install the native build dependencies (including Flex and Bison), then run python -m pip wheel .. Parser-source selection is automatic: a Git checkout generates the Verilog parser, while release source distributions with bundled generated parser files use those files. An explicit -C cmake.define.PREGENERATED_PARSER_SOURCES=ON or OFF still overrides the selection; ON requires the bundled files to exist.
Tutorials
Six hands-on notebooks — open any of them in Google Colab with no local install needed:
# |
Topic |
Colab |
|---|---|---|
1 |
Getting started — load Verilog, navigate hierarchy, visualize |
|
2 |
Liberty primitives — load a synthesised design with standard cells |
|
3 |
Editing a netlist — rename, disconnect, reconnect, delete |
|
4 |
SystemVerilog elaboration — load and browse an elaborated SV design |
|
5 |
ibex RISC-V core — explore a real-world SV core, collect module stats |
|
6 |
Fanout analysis — compute fanout for every net, trace drivers, export to pandas |
|
Links
License
Apache License 2.0. See the LICENSE file for details.
1 maintainer
Metadata
1 maintainer
Release files for najaeda 0.7.33
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| najaeda-0.7.33.tar.gz | 16.2 MB | Without provenance | Details for najaeda-0.7.33.tar.gz |
Built distributions (wheels)
Total release size: 277.3 MB
Release files / najaeda-0.7.33.tar.gz
| Download URL | najaeda-0.7.33.tar.gz |
|---|---|
| Size | 16.2 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
35c989777ffa492277760d7bee022ad1186c55bf213df42e02a8205f5d2ec689
|
|
BLAKE2b-256 checksum How to use checksums |
9a104330b21df70847128e9cf7d8c67f77263485149689936a12d6b97e82dc51
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / najaeda-0.7.33-cp315-cp315-win_amd64.whl
| Download URL | najaeda-0.7.33-cp315-cp315-win_amd64.whl |
|---|---|
| Size | 11.9 MB |
| Tags | CPython 3.15 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
23c3ed847a785960a0e62cce8cb8b68213e51ede778b77e8b955fb510edd1621
|
|
BLAKE2b-256 checksum How to use checksums |
d13a36d2ba3187aa03275c599791250668bebbd902063d4d4fae0c8c433d2e24
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / najaeda-0.7.33-cp315-cp315-manylinux_2_28_x86_64.whl
| Download URL | najaeda-0.7.33-cp315-cp315-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 11.2 MB |
| Tags | CPython 3.15 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
753401c233260531823679dc42124337aebd3e5c6878cf4901248377227e7ecf
|
|
BLAKE2b-256 checksum How to use checksums |
f9f6c8308887a09620b206d465f57c75f0e8385afb2eae9704b8bf56ea68efa4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / najaeda-0.7.33-cp315-cp315-manylinux_2_28_aarch64.whl
| Download URL | najaeda-0.7.33-cp315-cp315-manylinux_2_28_aarch64.whl |
|---|---|
| Size | 10.3 MB |
| Tags | CPython 3.15 Linux glibc 2.28+ ARM64 |
|
SHA-256 checksum How to use checksums |
948a5de54091ab84d18f8612f9a7c5f8604e2598073f516febfaee3c2aa45f63
|
|
BLAKE2b-256 checksum How to use checksums |
561550409d07472e98e0852873ebe8fbfe613331f453672c95c20ee19f743ee0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / najaeda-0.7.33-cp315-cp315-macosx_11_0_arm64.whl
| Download URL | najaeda-0.7.33-cp315-cp315-macosx_11_0_arm64.whl |
|---|---|
| Size | 7.1 MB |
| Tags | CPython 3.15 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
c5d195652101b21e21e547678b35b961bad51ed58a8134899f63f048451d68f1
|
|
BLAKE2b-256 checksum How to use checksums |
c01a6fa62863ad9ce23780cf25dbd0b86e84e49ee2e4f0ab0ef1f440fe70f15c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / najaeda-0.7.33-cp314-cp314t-manylinux_2_28_x86_64.whl
| Download URL | najaeda-0.7.33-cp314-cp314t-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 11.2 MB |
| Tags | CPython 3.14 CPython 3.14 free-threading Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
debbb9b9bec58a72d1bc92cdb230d5e38e9179aa27897e461e1e32d8e228dc2f
|
|
BLAKE2b-256 checksum How to use checksums |
6c7d64bf4f642a5ef3a900ca635ac91ff81c19a9fca02ab768ecb000a8b59b3c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / najaeda-0.7.33-cp314-cp314t-macosx_11_0_arm64.whl
| Download URL | najaeda-0.7.33-cp314-cp314t-macosx_11_0_arm64.whl |
|---|---|
| Size | 7.1 MB |
| Tags | CPython 3.14 CPython 3.14 free-threading macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
a050014848bf41ab3028d76bfde6fbad307aee170d94c3a8decf06bfcb074590
|
|
BLAKE2b-256 checksum How to use checksums |
b8cbdfca1032f8f39af15af5e91dfde9f296eb459d27ebb031c1b56191e2119d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / najaeda-0.7.33-cp314-cp314-win_amd64.whl
| Download URL | najaeda-0.7.33-cp314-cp314-win_amd64.whl |
|---|---|
| Size | 11.9 MB |
| Tags | CPython 3.14 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
ced3f2298e03f89be534db2497ecab5f98aaddd6328afbb0a66a34b2011741f1
|
|
BLAKE2b-256 checksum How to use checksums |
3e94f22a8938aa506ca7eb8bcf3f78b8601aae0a343c1f668a57ed8738a3789a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / najaeda-0.7.33-cp314-cp314-manylinux_2_28_x86_64.whl
| Download URL | najaeda-0.7.33-cp314-cp314-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 11.2 MB |
| Tags | CPython 3.14 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
e5940583a97f37ab6169caf9b2562a930f4bab2d7865eb61a7e040575819288d
|
|
BLAKE2b-256 checksum How to use checksums |
11d88c5f3ca55e8d64f6d028594e22daa2f487808444dea7540c0217ce5acfdf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / najaeda-0.7.33-cp314-cp314-manylinux_2_28_aarch64.whl
| Download URL | najaeda-0.7.33-cp314-cp314-manylinux_2_28_aarch64.whl |
|---|---|
| Size | 10.3 MB |
| Tags | CPython 3.14 Linux glibc 2.28+ ARM64 |
|
SHA-256 checksum How to use checksums |
7933a4b28da8b1a954126fa26cc1a847b45782d43bcd69d75ae94aec497797bc
|
|
BLAKE2b-256 checksum How to use checksums |
ca3f349f26e8bee398846c3cc3586e8e435aec3abb9a7430a9a1c6bfea98788e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / najaeda-0.7.33-cp314-cp314-macosx_11_0_arm64.whl
| Download URL | najaeda-0.7.33-cp314-cp314-macosx_11_0_arm64.whl |
|---|---|
| Size | 7.1 MB |
| Tags | CPython 3.14 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
cd858510935148ec4ac452b88cbe2e6075eef8eec9d7242eabb65e033ab64fd8
|
|
BLAKE2b-256 checksum How to use checksums |
f5078289f9719859f2e12a83dff21ca3c9e89408e3f382125883a7edb8bab2a4
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / najaeda-0.7.33-cp313-cp313-win_amd64.whl
| Download URL | najaeda-0.7.33-cp313-cp313-win_amd64.whl |
|---|---|
| Size | 11.8 MB |
| Tags | CPython 3.13 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
8ac649a6bbee33bfdd617269c993ea3b55feb8837c2da73b6ff7622879f51348
|
|
BLAKE2b-256 checksum How to use checksums |
08b49bac3ef807acc06a3da97a244218f37ccc439415cacdc86a1f424a58f41f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / najaeda-0.7.33-cp313-cp313-manylinux_2_28_x86_64.whl
| Download URL | najaeda-0.7.33-cp313-cp313-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 11.2 MB |
| Tags | CPython 3.13 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
03ae4c6afabadfbebd6923be4f77e98261d1e1587c49e4cc0c01c0162544f917
|
|
BLAKE2b-256 checksum How to use checksums |
a43e95ae5e76da0804c1d00ecebbabd1b0b97e49faef024be47f72626e7e7b32
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / najaeda-0.7.33-cp313-cp313-manylinux_2_28_aarch64.whl
| Download URL | najaeda-0.7.33-cp313-cp313-manylinux_2_28_aarch64.whl |
|---|---|
| Size | 10.3 MB |
| Tags | CPython 3.13 Linux glibc 2.28+ ARM64 |
|
SHA-256 checksum How to use checksums |
7a34b024b17ab24c43360e02b359a950c9f1520e6bcc9ebc8e895466735b3070
|
|
BLAKE2b-256 checksum How to use checksums |
34854756daf2573fc5b7b3319d6f40fe9b5a1344e7912c0fbaffb455beb0d32a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / najaeda-0.7.33-cp313-cp313-macosx_11_0_arm64.whl
| Download URL | najaeda-0.7.33-cp313-cp313-macosx_11_0_arm64.whl |
|---|---|
| Size | 7.1 MB |
| Tags | CPython 3.13 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
ae20ea54c9f5966b06f91a142a53ea94e7323155e97603395d861e8fc8b72e2e
|
|
BLAKE2b-256 checksum How to use checksums |
ce8a1ff731c1bd0e565bee5154e3476b2f70b2151c07299106aba0b90efe7d44
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / najaeda-0.7.33-cp312-cp312-win_amd64.whl
| Download URL | najaeda-0.7.33-cp312-cp312-win_amd64.whl |
|---|---|
| Size | 11.8 MB |
| Tags | CPython 3.12 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
aa6cbb6f886e9b225388f3f877ee0899d9cddbb486e110964ad031c2718ca114
|
|
BLAKE2b-256 checksum How to use checksums |
1ec9d3a29a259d98a21c71af0f554aa3eb77c2a61651c5aa469c6e5b6a5260fc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / najaeda-0.7.33-cp312-cp312-manylinux_2_28_x86_64.whl
| Download URL | najaeda-0.7.33-cp312-cp312-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 11.2 MB |
| Tags | CPython 3.12 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
ab73c91dcb3c44300a64fbf572489961842a83e0612d4f7514b47cea15bf2bb3
|
|
BLAKE2b-256 checksum How to use checksums |
b42bf5defad98d5ff1ff7413c3a09e9352fce3f51796601f0684254b1e67af44
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / najaeda-0.7.33-cp312-cp312-manylinux_2_28_aarch64.whl
| Download URL | najaeda-0.7.33-cp312-cp312-manylinux_2_28_aarch64.whl |
|---|---|
| Size | 10.3 MB |
| Tags | CPython 3.12 Linux glibc 2.28+ ARM64 |
|
SHA-256 checksum How to use checksums |
eb2e2a6e62f2d0682d6fdd776050b4c419f7dfeb8491d7f504255243a3670e51
|
|
BLAKE2b-256 checksum How to use checksums |
b96fca78015ea7839cf2b486b726945929b5c72b6ed0f7509ff7a52cd395c785
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / najaeda-0.7.33-cp312-cp312-macosx_11_0_arm64.whl
| Download URL | najaeda-0.7.33-cp312-cp312-macosx_11_0_arm64.whl |
|---|---|
| Size | 7.1 MB |
| Tags | CPython 3.12 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
be7e25b2f949f619de67232ec9fa9b69ba3af345f0444f84a02c8d961fa440d8
|
|
BLAKE2b-256 checksum How to use checksums |
91dedfee1b4213b05d4e2b072aa1f506dae355ac3691e9285b33eed39113baf6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / najaeda-0.7.33-cp311-cp311-win_amd64.whl
| Download URL | najaeda-0.7.33-cp311-cp311-win_amd64.whl |
|---|---|
| Size | 11.8 MB |
| Tags | CPython 3.11 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
ffe5b6098a66e202262cf8f2df78db81cb6e88eb93873fc7ce74815396702996
|
|
BLAKE2b-256 checksum How to use checksums |
4e7043e367268924145e8da401e71ada789f8e3ca002e0de5aea3661663cb785
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / najaeda-0.7.33-cp311-cp311-manylinux_2_28_x86_64.whl
| Download URL | najaeda-0.7.33-cp311-cp311-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 11.2 MB |
| Tags | CPython 3.11 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
43802e291aec2a7657b2554d938e3d476c356a7f615d83eb1e7e2c0f6100e262
|
|
BLAKE2b-256 checksum How to use checksums |
d1ca670c235a4c1b50be7c1bf8381e5eefe7c034297abfa77eaf9ab4129b6e29
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / najaeda-0.7.33-cp311-cp311-manylinux_2_28_aarch64.whl
| Download URL | najaeda-0.7.33-cp311-cp311-manylinux_2_28_aarch64.whl |
|---|---|
| Size | 10.3 MB |
| Tags | CPython 3.11 Linux glibc 2.28+ ARM64 |
|
SHA-256 checksum How to use checksums |
11e9e2bee7d71119cb391f600796329971279df26e239361a216a3d815a814f1
|
|
BLAKE2b-256 checksum How to use checksums |
6fece988671f68a9de2ccfc3a764d9e3eb2219651df22fb8f0a7482547cf4d05
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / najaeda-0.7.33-cp311-cp311-macosx_11_0_arm64.whl
| Download URL | najaeda-0.7.33-cp311-cp311-macosx_11_0_arm64.whl |
|---|---|
| Size | 7.1 MB |
| Tags | CPython 3.11 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
756d8c4fd39dc613493ebb1436f0d61a480f23d22627c458ade10fa5962f40a4
|
|
BLAKE2b-256 checksum How to use checksums |
7e9859661d3e268e55319a46073c75bee1f6a5bfd42cedeb72d6dd0bea04426c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / najaeda-0.7.33-cp310-cp310-win_amd64.whl
| Download URL | najaeda-0.7.33-cp310-cp310-win_amd64.whl |
|---|---|
| Size | 11.8 MB |
| Tags | CPython 3.10 Windows x86-64 |
|
SHA-256 checksum How to use checksums |
080d7d891ae4c9efcc78fe386a19fef6d077285ed1215491c144066e65bf8286
|
|
BLAKE2b-256 checksum How to use checksums |
10172dc0fed3b70628d63be68fa309bb8f1c50b0dea79dc433f56a6953f7988b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / najaeda-0.7.33-cp310-cp310-manylinux_2_28_x86_64.whl
| Download URL | najaeda-0.7.33-cp310-cp310-manylinux_2_28_x86_64.whl |
|---|---|
| Size | 11.2 MB |
| Tags | CPython 3.10 Linux glibc 2.28+ x86-64 |
|
SHA-256 checksum How to use checksums |
c1a11cf3dd86c691ecf51109b3a041ae0cc53f76b3a1215ec5d29cba9844f17b
|
|
BLAKE2b-256 checksum How to use checksums |
875f857f7936f24b49aa81849d73b90adc6e23e8ef18b0231861acde8063ba67
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / najaeda-0.7.33-cp310-cp310-manylinux_2_28_aarch64.whl
| Download URL | najaeda-0.7.33-cp310-cp310-manylinux_2_28_aarch64.whl |
|---|---|
| Size | 10.3 MB |
| Tags | CPython 3.10 Linux glibc 2.28+ ARM64 |
|
SHA-256 checksum How to use checksums |
55dc913ec06cd9d5d46fc0cd9b468719371cfac5f276f7c475f67fd74a9282de
|
|
BLAKE2b-256 checksum How to use checksums |
4c5bd0286cb8b361e84acdce9d8dfc177dc0bdc968d22f80e9265b4f84b156a7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Release files / najaeda-0.7.33-cp310-cp310-macosx_11_0_arm64.whl
| Download URL | najaeda-0.7.33-cp310-cp310-macosx_11_0_arm64.whl |
|---|---|
| Size | 7.1 MB |
| Tags | CPython 3.10 macOS 11.0+ ARM64 |
|
SHA-256 checksum How to use checksums |
fcd2e10eb45b3a7c22cf68f20b2ee031e383f61066528db312a6b31e13d50d2d
|
|
BLAKE2b-256 checksum How to use checksums |
b9e6ae5a82ae32186d457b805afb0462892ad6a230618ed373c3260c1a8df852
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Security for najaeda 0.7.33
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.
