From 01b0b2231d3d651d07efbd591ea9ea5b7b851ab2 Mon Sep 17 00:00:00 2001 From: Eyck Jentzsch Date: Thu, 4 May 2023 21:06:49 +0200 Subject: [PATCH] adds toplevel README --- README.md | 78 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 78 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..f1a42f7 --- /dev/null +++ b/README.md @@ -0,0 +1,78 @@ +# TGC-ISS + +The ISS for the cores of The Good Folk Series (TGFS) of MINRES. + +This ISS is based in DBT-RISE, a library to allow rapid ISS creation. + +## Quick start + +* you need to have a C++14 capable compiler, make or ninja, python, and cmake installed + +### common setup + +* install conan.io (see also http://docs.conan.io/en/latest/installation.html): + + ``` + + pip3 install --user conan==1.59 + + ``` + + Another option is to use a Python VENV to isolate the used models from the system. + In case of please run: + + ```sh + + python -mvenv .venv + source .venv/bin/activate + pip3 install conan==1.59 + + ``` + + Using conan for the first time you need to create a profile: + + ``` + + conan profile create default --detect + + ``` + +* checkout source from git + + ```sh + + git clone --recursive -b develop https://git.minres.com/TGFS/TGC-ISS.git + + ``` + +### Accellera SystemC build + +* start an out-of-source build: + + ``` + + cd TGC-ISS + cmake -S . -B build/Debug + cmake --build build/Debug -j10 + + ``` + + +### Synopsys Platform Architect build + +Assuming environment for Platform Architect is properly set up. + +``` + + cd TGC-ISS/ + export TGFS_INSTALL_ROOT `pwd`/install + export SNPS_ENABLE_MEM_ON_DEMAND_IN_GENERIC_MEM=1 + export CC=$COWAREHOME/SLS/linux/common/bin/gcc + export CXX=$COWAREHOME/SLS/linux/common/bin/g++ + cmake -S . -B build/PA -DCMAKE_BUILD_TYPE=Debug -DUSE_CWR_SYSTEMC=ON \ + -DBUILD_SHARED_LIBS=ON -DCODEGEN=OFF -DCMAKE_INSTALL_PREFIX=${TGFS_INSTALL_ROOT} + cmake --build build/PA --target install -j16 + +``` + +Now you may change to dbt-rise-tgc/contrib to import the core model \ No newline at end of file