Posted 2024-04-20Updated 2025-01-15Note2 minutes read (About 358 words)

The example site: https://chen-yulin.github.io/Besiege-Modern-Docs/

Initialize the local project

node -v >= 18.0

1	npm init docusaurus@latest Besiege-Modern-Mod-docs classic

/developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort#browser_compatibility
✔ Which language do you want to use? › JavaScript
[INFO] Creating new Docusaurus project...
[INFO] Installing dependencies with npm...
...
[SUCCESS] Created Besiege-Modern-Mod-docs.
[INFO] Inside that directory, you can run several commands:

  `npm start`
    Starts the development server.

  `npm run build`
    Bundles your website into static files for production.

  `npm run serve`
    Serves the built website locally.

  `npm run deploy`
    Publishes the website to GitHub pages.

We recommend that you begin by typing:

  `cd Besiege-Modern-Mod-docs`
  `npm start`

Happy building awesome websites!

Configuration

Add a source code button

src/pages/index.js,in function HomepageHeader(), add a <div>.

function HomepageHeader() {
  const {siteConfig} = useDocusaurusContext();
  return (
    <header className={clsx('hero hero--primary', styles.heroBanner)}>
      <div className="container">
        <Heading as="h1" className="hero__title">
          {siteConfig.title}
        </Heading>
        <p className="hero__subtitle">{siteConfig.tagline}</p>
        <div className={styles.buttons}>
          <Link
            className="button button--secondary button--lg"
            to="/docs/intro">
            Getting Started ⏱️
          </Link>
        </div>
        // +++++++++[[
        <div className={styles.buttons}>
          <Link
            className="button button--secondary button--lg"
            to="https://github.com/Chen-Yulin/Besiege-Modern-Mod">
            Source code
          </Link>
        </div>
        // ]]+++++++++
      </div>
    </header>
  );
}

Two button too close to each other, change the css style for button.
In src/pages/index.module.css

.buttons {
  display: flex;
  align-items: center;
  justify-content: center;
  margin-top: 1rem; // +++
}

Deployment

Add the remote repository on github.

1	git remote add origin git@github.com:Chen-Yulin/Besiege-Modern-Docs.git

Change the deployment configurations

// Set the production url of your site here
url: 'https://chen-yulin.github.io',
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: '/Besiege-Modern-Docs/',

// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: 'Chen-Yulin', // Usually your GitHub org/user name.
projectName: 'Besiege-Modern-Docs', // Usually your repo name.
deploymentBranch: 'deploy',
trailingSlash: false,

Change the page setting in repository settings, Branch set to deploy branch.

Deploy command: yarn deploy

[INFO] `git commit -m "Deploy website - based on aa492c3f0934f0177ca946345c2d32940c1900c3"` code: 0
To github.com:Chen-Yulin/Besiege-Modern-Docs.git
 * [new branch]      deploy -> deploy
[INFO] `git push --force origin deploy` code: 0
Website is live at "https://Chen-Yulin.github.io/Besiege-Modern-Docs/".

Posted 2024-04-19Updated 2025-01-15Note11 minutes read (About 1579 words)

Automate OpenROAD testing

Purpose:

We use OpenROAD to generate timing analysis reports for each design. However, manually modifying parameters, running commands, and intercepting important information will be too arduous work. It is mainly due to the following points.

First of all, the report generated by OpenROAD for each design is too long, and the report file may be as large as hundreds of megabytes. It is almost impossible to open and find tns, wns data using a text editor.
Secondly, the locations of the configuration files running OpenROAD are very scattered. Moreover, the configuration file directory for timing modification is stored in the tcl script. Manual search and modification are too anti-human and prone to misoperation.
Furthermore, the amount of data we need is very large. For each design, we hope to test its performance under 7 different clock cycles and 5 different core area sizes. In other words, for each design, it is necessary to manually modify parameters, run commands, and intercept important information 35 times, which is unbearable, not to mention that we have 7 designs.
Due to these drawbacks, I decided to use shell script to automate the process of OpenROAD testing. I have the following requirements for the script.
The script can modify the core_area, die_area parameter in the tcl script given the path to the tcl script and the desired scale of area.
The script can modify the create_clock‘s -period parameter in the sdc configuration file referred by the tcl script, given the path to the tcl script and the desired clock period.
The script can set all the parameters and run OpenROAD analysis one by one, given the choice set of clock period and area scale.
After the OpenROAD generated the report file, the script can read the report and extract the information of tns & wns for each stop point and export these data to a csv table.

Main Test Framework

The entry script is named as runit.gxy, which can receive the name of design as an argument.
For each design, the corresponding tcl script is fixed, so I decided to map the name of design to the tcl script.

design="$1"
if [ "${design}" = "APU" ]; then
  file_path_orig="../dataset/run/greedy/APU/10n.tcl"
  file_path="../dataset/run/greedy/APU/10n_bak.tcl"
elif [ "${design}" = "ppu" ]; then
  file_path_orig="../dataset/run/greedy/ppu/5n.tcl"
  file_path="../dataset/run/greedy/ppu/5n_bak.tcl"
elif [ "${design}" = "xtea" ]; then
  file_path_orig="../dataset/run/greedy/xtea/5n.tcl"
  file_path="../dataset/run/greedy/xtea/5n_bak.tcl"
elif [ "${design}" = "yhuff" ]; then
  file_path_orig="../dataset/run/greedy/yh/5n.tcl"
  file_path="../dataset/run/greedy/yh/5n_bak.tcl"
elif [ "${design}" = "dynamic_node" ]; then
  file_path_orig="../dataset/run/greedy/dy/5n2.tcl"
  file_path="../dataset/run/greedy/dy/5n2_bak.tcl"
elif [ "${design}" = "ibex" ]; then
  file_path_orig="../dataset/run/ibex_tcl/C0A0.tcl"
  file_path="../dataset/run/ibex_tcl/C0A0_bak.tcl"
elif [ "${design}" = "salsa20" ]; then
  file_path_orig="../dataset/run/greedy/sal/5n.tcl"
  file_path="../dataset/run/greedy/sal/5n_bak.tcl"
else
  echo "no such design"
  exit 1
fi

if [ ! -f "$file_path" ]; then
    echo "File $file_path not found."
    if [ ! -f "$file_path_orig" ]; then
      echo "Origin file ${file_path_orig} not found."
      exit 1
    fi
    cp $file_path_orig $file_path
fi

The reason I use _bak post-fix is that, I want to reserve the original core_area and die_area configuration in the origin tcl file, since the original configuration is needed in the following steps.

Then I use nested loop to change the configuration one by one. The choice set can be modified in the condition statement of each for loop.

for period in 2 4 6 8 10 12 14
do
  # set clk period
  for scale in 0.2 0.4 0.6 0.8 1
  do
    # set area scale
    #run openroad
    timeout 5 ../../OpenROAD-flow-scripts/tools/OpenROAD/build/src/openroad $file_path > $output_path
    # collect data and export to csv
  done
done

The set clk period, set area scale, export to csv function will be covered in the following steps.

Set the Period of Clock

I create a new shell script called set_clk.sh to manage the automation of changing clock period.
It takes two arguments, the path to the tcl script (string) and the desired clock period (integer).
I first preprocess the period parameter, namely, divide it by 10.

time="$2"
period=$(echo "scale=1; $time / 10.0" | bc)
if [[ $period =~ ^\. ]]; then
	period="0$period"
fi

The clock configuration can be modified in the sdc file, while the path to the sdc file can be extracted from the tcl file, with the format of set sdc_file "PATH_TO_SDC"
I decided to use grep to locate the line of set sdc_file and extract the path to sdc file using regex substitution.

1 2	tcl_path="$1" sdc_path=$(grep 'set sdc_file' "$tcl_path" \| sed 's/."$.$".*/\1/')

In the sdc file, the configuration has a format of create_clock ... -period 0.x.
Still, use regex substitution to replace the original period with the input period and everything is done.

1	sed -i "s/^$create_clock.-period $[0-9]\.[0-9]$.$$/\1$period\2/" "$sdc_path"

Set the `core_area` and `die_area`

The area of the design is expressed in the form of {x1 y1 x2 y2}, where x1 y1 stands for the coordinate of bottom-left corner and x2 y2 stands for the coordinate of upper-right corner.
Since the area of different design varies a lot, I need to change the area proportionately. As a result I need to reserve the original area stored in tcl script as mentioned before.

First, I read the origianl core_area and die_area from the original script.

file_path="$1"
orig_path="${file_path//_bak}" # remove the _bak postfix_

core_area=$(grep 'set core_area' "$orig_path" | sed -n 's/.*{\([^}]*\)}.*/\1/p')
die_area=$(grep 'set die_area' "$orig_path" | sed -n 's/.*{\([^}]*\)}.*/\1/p')

IFS=' ' read -r core1 core2 core3 core4 <<< "$core_area"

IFS=' ' read -r die1 die2 die3 die4 <<< "$die_area"

Then I calculate the desired core/die area size based on the scale and original area.

core_x_size=$(echo "$core3" - "$core1" | bc)
core_y_size=$(echo "$core4" - "$core2" | bc)

core1=$(echo "$core1 + $core_x_size * (1 - $2) / 2" | bc)
core3=$(echo "$core3 - $core_x_size * (1 - $2) / 2" | bc)

core2=$(echo "$core2 + $core_y_size * (1 - $2) / 2" | bc)
core4=$(echo "$core4 - $core_y_size * (1 - $2) / 2" | bc)

die1=$(echo "$core1" - "10" | bc)
die2=$(echo "$core2" - "10" | bc)
die3=$(echo "$core3" + "10" | bc)
die4=$(echo "$core4" + "10" | bc)

Finally, use regex substitution to modify the area configuration in _bak.tcl script.

1 2	sed -i "s/die_area {[^}]}/die_area {$die1 $die2 $die3 $die4}/g" "$file_path" sed -i "s/core_area {[^}]}/core_area {$core1 $core2 $core3 $core4}/g" "$file_path"

Collect data and export to `.csv`

The key information I need from the report generated by OpenROAD is tns & wns.
By observation, the block containing the data has the following pattern.

***
result of: stoppoint*
tns: [number1]
wns: [number2]
***

Therefore, I use the grep and awk command to get the last word in each data block. In this case, it’s stoppoint*, [number1], [number2].

1 2	input_file="$1" tnswns=$(grep -A 2 "result of" "$input_file" \| awk '/result of/{p=3} p&&p--' \| awk '{print $NF}')

Each report contains totally 6 valid stop points, so I use a loop to get the desired data.

csv_file="${design}.csv"
for nr in 2 5 8 11 14 17
do
	stoppoint=$((stoppoint+1))
	tns=$(echo "$tnswns" | awk -v nr="$nr" 'NR==nr')
	nr_wns=$(echo "$nr + 1" | bc)
	wns=$(echo "$tnswns" | awk -v nr="$nr_wns" 'NR==nr')
	# export to csv table
done

After getting the desired tns and tws, I want to export these data to a csv table.
I decided to let the table has the following columns, period, scale, stop point number, tns and wns, one such table for each design.
This function can be achieved with the following script

design="$2"
period="$3"
scale="$4"
echo "${period},${scale},stoppoint${stoppoint},${tns},${wns}" >> $csv_file

Replace the comment in the loop and everything is done.

Result

I assemble runit_gxy.sh in a single script named runit_cyl.sh to run the analysis of all designs at once.

1
2
3

./runit_gxy.sh APU
./runit_gxy.sh ppu
...

Then redirect the output to runit_cyl.log.

Here is the content of APU.csv and runit_cyl.log

Period,Scale,Stoppoint,tns,wns
2,1,stoppoint1,-17.2309532166,-0.4609909952
2,1,stoppoint2,-13.7819681168,-0.4073848128
2,1,stoppoint3,-13.7819681168,-0.4073848128
2,1,stoppoint4,-14.1436796188,-0.3814869523
2,1,stoppoint5,-14.1436796188,-0.3814869523
2,1,stoppoint6,-14.1436796188,-0.3814869523
2,0.95,stoppoint1,-17.2309532166,-0.4609909952
2,0.95,stoppoint2,,
2,0.95,stoppoint3,,
2,0.95,stoppoint4,,
2,0.95,stoppoint5,,
2,0.95,stoppoint6,,
2,0.9,stoppoint1,-17.2309532166,-0.4609909952
2,0.9,stoppoint2,,
2,0.9,stoppoint3,,
2,0.9,stoppoint4,,
2,0.9,stoppoint5,,
2,0.9,stoppoint6,,
4,1,stoppoint1,-8.3930120468,-0.2609909773
4,1,stoppoint2,-4.7969579697,-0.2073848099
4,1,stoppoint3,-4.7969579697,-0.2073848099
4,1,stoppoint4,-4.5129084587,-0.1783644110
4,1,stoppoint5,-4.5129084587,-0.1783644110
4,1,stoppoint6,-4.5129084587,-0.1783644110
4,0.95,stoppoint1,-8.3930120468,-0.2609909773
4,0.95,stoppoint2,,
4,0.95,stoppoint3,,
4,0.95,stoppoint4,,
4,0.95,stoppoint5,,
4,0.95,stoppoint6,,
4,0.9,stoppoint1,-8.3930120468,-0.2609909773
4,0.9,stoppoint2,,
4,0.9,stoppoint3,,
4,0.9,stoppoint4,,
4,0.9,stoppoint5,,
4,0.9,stoppoint6,,
6,1,stoppoint1,-1.8987674713,-0.0609909929
6,1,stoppoint2,-0.0572821237,-0.0073847598
6,1,stoppoint3,-0.0572821237,-0.0073847598
6,1,stoppoint4,0.0000000000,0.0000000000
6,1,stoppoint5,0.0000000000,0.0000000000
6,1,stoppoint6,0.0000000000,0.0000000000
...

use design: APU
use tcl file path ../dataset/run/greedy/APU/10n_bak.tcl
get sdc path: ../dataset/run/greedy/gcd/1/gcd_nangate45.sdc
Change period to 0.2
create_clock [get_ports clk] -name core_clock -period 0.2
core area difference 60.18 59.8
set die_area {.07 1.2 80.25 81}
set core_area {10.07 11.2 70.25 71}
collecting data
core area difference 60.18 59.8
set die_area {1.07 2.2 79.25 80}
set core_area {11.07 12.2 69.25 70}
collecting data
core area difference 60.18 59.8
set die_area {3.07 3.2 77.25 79}
set core_area {13.07 13.2 67.25 69}
collecting data
get sdc path: ../dataset/run/greedy/gcd/1/gcd_nangate45.sdc
Change period to 0.4
create_clock [get_ports clk] -name core_clock -period 0.4
core area difference 60.18 59.8
set die_area {.07 1.2 80.25 81}
set core_area {10.07 11.2 70.25 71}
collecting data
core area difference 60.18 59.8
set die_area {1.07 2.2 79.25 80}
set core_area {11.07 12.2 69.25 70}
collecting data
core area difference 60.18 59.8
set die_area {3.07 3.2 77.25 79}
set core_area {13.07 13.2 67.25 69}
collecting data
get sdc path: ../dataset/run/greedy/gcd/1/gcd_nangate45.sdc
Change period to 0.6
create_clock [get_ports clk] -name core_clock -period 0.6
core area difference 60.18 59.8
set die_area {.07 1.2 80.25 81}
set core_area {10.07 11.2 70.25 71}
collecting data
...

Posted 2024-04-17Updated 2025-01-15Note3 minutes read (About 490 words)

ONI Modding

Basic

Useful tools

Dnspy: decompile the runtime library of ONI
Visual Studio (though it’s too fat)
Poedit: read the .po file for zh-en translation

Hello world

Apply patches on the Initialize() method in Db class.

public class Patches
    {
        [HarmonyPatch(typeof(Db))]
        [HarmonyPatch("Initialize")]
        public class Db_Initialize_Patch
        {
            public static void Prefix()
            {
                Debug.Log("Hello! Welcome to CuppyUniverse! [before Db.Initialize]");
            }

            public static void Postfix()
            {
                Debug.Log("CuppyUniverse initialized! [after Db.Initialize]");
            }
        }
        [HarmonyPatch(typeof(ElectrolyzerConfig))]
        [HarmonyPatch("CreateBuildingDef")]
        public class ElectrolyzerConfig_Patch
        {
            public static void Postfix(ref BuildingDef __result)
            {
                __result.EnergyConsumptionWhenActive = 114f;
            }
        }
    }

Add new building

Take gold washer (just like water purifier but output small amount of gold) as an example.

Find the source code for water purifier.
i.e.

using System;
using TUNING;
using UnityEngine;

// Token: 0x0200039A RID: 922
public class WaterPurifierConfig : IBuildingConfig
{
	// Token: 0x06001314 RID: 4884 RVA: 0x000665C4 File Offset: 0x000647C4
	public override BuildingDef CreateBuildingDef()
	{
		string id = "WaterPurifier";
		int width = 4;
		int height = 3;
		string anim = "waterpurifier_kanim";
		int hitpoints = 100;
		float construction_time = 30f;
		float[] tier = BUILDINGS.CONSTRUCTION_MASS_KG.TIER3;
		string[] all_METALS = MATERIALS.ALL_METALS;
		float melting_point = 800f;
		BuildLocationRule build_location_rule = BuildLocationRule.OnFloor;
		EffectorValues tier2 = NOISE_POLLUTION.NOISY.TIER3;
		BuildingDef buildingDef = BuildingTemplates.CreateBuildingDef(id, width, height, anim, hitpoints, construction_time, tier, all_METALS, melting_point, build_location_rule, BUILDINGS.DECOR.PENALTY.TIER2, tier2, 0.2f);
		...
		return buildingDef;
	}

	// Token: 0x06001315 RID: 4885 RVA: 0x000666A8 File Offset: 0x000648A8
	public override void ConfigureBuildingTemplate(GameObject go, Tag prefab_tag)
	{
		...
	}

	// Token: 0x06001316 RID: 4886 RVA: 0x0006688B File Offset: 0x00064A8B
	public override void DoPostConfigureComplete(GameObject go)
	{
		...
	}

	// Token: 0x04000A88 RID: 2696
	public const string ID = "WaterPurifier";

	// Token: 0x04000A89 RID: 2697
	private const float FILTER_INPUT_RATE = 1f;

	// Token: 0x04000A8A RID: 2698
	private const float DIRTY_WATER_INPUT_RATE = 5f;

	// Token: 0x04000A8B RID: 2699
	private const float FILTER_CAPACITY = 1200f;

	// Token: 0x04000A8C RID: 2700
	private const float USED_FILTER_OUTPUT_RATE = 0.2f;

	// Token: 0x04000A8D RID: 2701
	private const float CLEAN_WATER_OUTPUT_RATE = 5f;

	// Token: 0x04000A8E RID: 2702
	private const float TARGET_OUTPUT_TEMPERATURE = 313.15f;
}

Create a new csharp class file in VS and copy the content into it.
Remember to rename

the class name
id in method CreateBuildingDef()
ID in class
In this example change them to GoldWasher

Add GoldWasher to build menu.
create a new patch for GeneratedBuildings

using System;
using HarmonyLib;

namespace ONI_CuppyUniverse_Mod
{
    [HarmonyPatch(typeof(GeneratedBuildings), "LoadGeneratedBuildings")]
    public class GeneratedBuildings_LoadGeneratedBuildings
    {
        public static void Prefix()
        {
            Strings.Add(new string[] { 
                "STRINGS.BUILDINGS.PREFABS.GOLDWASHER.NAME",
                "淘金器"
            });
            Strings.Add(new string[] {
                "STRINGS.BUILDINGS.PREFABS.GOLDWASHER.EFFECT",
                "从纯净水中淘取黄金"
            });
            Strings.Add(new string[] {
                "STRINGS.BUILDINGS.PREFABS.GOLDWASHER.DESC",
                "你是信无中生有的"
            });
            ModUtil.AddBuildingToPlanScreen("Food", "GoldWasher");
        }
    }
}

Reference

Posted 2023-05-09Updated 2025-01-15Notea few seconds read (About 83 words)

merge

Git Merge

Git Merge
- Solve conflict
  - Tools
  - Commands

Solve conflict

Tools

In nvim, I use plugin fugitive

Commands

open two vertical buffer (one form target, another from feature)

1	:Gvdiffsplit!

stay on middle and use

1	:diffget [buffername](local)

OR
go to target/feature buffer and use

1	:diffput [buffername](target/feature)

save the local file and use

1 2	:Git add . :Git commit -m "solve merge conflicts"

Posted 2022-08-05Updated 2024-11-02Note2 minutes read (About 264 words)

Besiege mod "ModernAirCombat"

mod name: ModernAirCombat

Setup of mod

1	$createmod "ModernAirCombat"

modify ./Mod.xml

Author
Description

1	$createblock "ModernAirCombat" "SRAAM"

1	mkdir ./Resources/SRAAM

add assets of SRAAM block r73.obj, r73.png

modify ./Mod.xml

Add resources

1 2	<Mesh name="SRAAM Mesh" path="SRAAM\r73.obj"/> <Texture name="SRAAM Texture" path="SRAAM\r73.png"/>

modify ./SRAAM.xml

Mass
Mesh name
Texture name
Icon
Colliders
Points

create assembly for scripts

1	createassembly "ModernAirCombat" compiled MacAssembly ModernAirCombat forceUnityTools

open project with VStudio

edit ModernAirCombat.cs

using System;
using Modding;
using UnityEngine;

namespace ModernAirCombat
{
    public enum BlockList
    {
        SRAAM = 1,
        MRAAM = 2,
        LRAAM = 3
    }
    public class ModernAirCombat : ModEntryPoint
    {
        public static GameObject Mod;
        public override void OnLoad()
		    {
            Mod = new GameObject("Morden Firearm Kit Mod");
            UnityEngine.Object.DontDestroyOnLoad(Mod); \\avoid destroy mod instance when changing levels
            Debug.Log("Hello, this is Modern Air Combat！");
            // Called when the mod is loaded.
        }
    }
}

Write Block Scripts

add a block class SRAAM.cs

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Xml.Serialization;
using System.Collections;

using Modding.Modules;
using Modding;
using Modding.Blocks;
using UnityEngine;

namespace ModernAirCombat
{
    class SRAAMBlock : BlockScript
    {
        public MToggle IFF;
        public MSlider detectAngleSlider;
        private Transform myTransform;      //实例化Transform对象
        private Rigidbody myRigidbody;

        public override void SafeAwake()
        {
            IFF = AddToggle("开启友伤", "IFF", true);
            detectAngleSlider = AddSlider("探测角度", "detection angle", 45.0f, 0.0f, 150.0f);
        }
        private void Start()
        {
            myTransform = gameObject.GetComponent<Transform>();        //获取相应对象的引用
            myRigidbody = gameObject.GetComponent<Rigidbody>();
            myRigidbody.drag = 2;
            myRigidbody.angularDrag = 4;
        }

        public override void OnSimulateStart()
        {
            base.OnSimulateStart();
        }

        public override void OnSimulateStop()
        {
            base.OnSimulateStop();
        }

        private void Update() {
            myRigidbody.AddRelativeForce(new Vector3(0, 1, 0), ForceMode.Impulse);
        }
    }
}

modify SRAAM.xml

1	<Script>ModernAirCombat.SRAAMBlock</Script>

Posted 2022-05-21Updated 2024-11-02Notea few seconds read (About 11 words)

VE216 Note

Posted 2022-05-14Updated 2024-11-02Notea few seconds read (About 11 words)

VE401 Note

Posted 2022-05-14Updated 2024-11-02Notea few seconds read (About 11 words)

VE203 Note

Posted 2022-05-13Updated 2024-11-02Notea few seconds read (About 91 words)

Check for WSL GUI Service

This guide is for the wslg feature of windows 11.
Check for display:

1 2	$ echo $DISPLAY :0

if not, change it with:

1	$ export DISPLAY=:0

check for X11 display socket

1 2	$ ls -la /tmp/.X11-unix lrwxrwxrwx 1 spronovo spronovo 19 Apr 21 15:28 /tmp/.X11-unix -> /mnt/wslg/.X11-unix

This is setup during WSL’s INIT.
If doesn’t exist, re-create it to try things out:

1 2	$ sudo rm -r /tmp/.X11-unix $ ln -s /mnt/wslg/.X11-unix /tmp/.X11-unix

Check whether X11 server is running:

1 2	$ ls /tmp/.X11-unix X0

Posted 2022-05-09Updated 2024-11-02Note3 minutes read (About 514 words)

TC300 note

Catalog

Course Introduction
* Common Tenses and Voices
Writing Email
Resume
CV
Peer-reviewed Article Publishing
Citation
Technical Project Deliverables

Course Introduction

What is TC?
Communication that presents specific information to a specific audience for a specific purpose

who is audience?
what information are we commmunicating?
why are we communicating

Criteria of TC:

Accuracy
Brevity
- no need for complex sentense, idea itself is complicated enough
Clarify

Topics:

Workplace-related communications
Technical project design through a problem-need-solution framework
Diagrams and data visualization, reporting results
Paraphrasing, direct quotation, citation(AIAA)
presentation skills

Requirements

No late homework submission
Attendance and active participation
HC & plagiarism

Common Tenses and Voices

Tenses

Use present tense a lot.
If action happens in the past and is done, use past tense (if is true till now, use present tense(project, theorms))

Voices

Use active voice, engaged and easier to read
Use passive voice to put emphasis on action or the subject is unknow
Do not use we, be objective

Writing Email

Components:

address lines
subject line
salutation
introduction, body and conclusion
closing
signiture
signiture section

Notes:

no conversation
don’t send confidential information
one single page is enough
forward to others only when is authorized
pause before sending
clean out mailboxes

Three different levels of formality:

Personal, brief notes
Memo style
Letter style: formal business emails

Be careful when using !, it is super strong tone, meaning frustrated, very very angry.

Resume

Common traits

How to state your impact?

What was differnent or better when you finish?
What were obstacles and how did you get around them?
What did you learn in that experience?

Name & Time:

Yulin Chen
Chen, Yulin
May 2022

#CV
Sections:

Contact info
Education
Experience
Teaching

Peer-reviewed Article Publishing

Process

Manuscript prepared by authors
Submission(System)
- may reject by AI if format is wrong
Initial Eval.(Managing editor)
- may reject if logic wrong
Editor’s Eval.(Chief editors)
- if not good enough, may reject
Reviewing(Reviewers)
read review advice(Editor)
- if need author’s Rev. give back to author, then submit again
- no thing required, publish
- or reject if still not good enough

Citation

name [index]
endOfSentense [index1-index2].
- the sentense is a summary of works cited ad index1-index2(multiple references)
endOfSentense. [index]
- cover several sentenses ahead

General Rule : if not cited, you are claiming that it is your own work.
Five-consecutive-word Rule
So we need paraphrasing

Use different vacabulary
Change order of words
Different grammar/sentense structure

Style:

MLA
- Modern Language Association
APA
CMS
AAAS
AIAA
ACS
IEEE has many different styles

Technical Project Deliverables

Deliverables:

Project
Solution
Finding
Publication
Patent
all end up with a report

TC element

Audience
- Potential/existing customers, fellow engineers, colleagues from other departments
- Professors, classmates, staffs
- General readers interested
Information
- Project’s ‘result’ (not everything of the project)
Purpose
- Promote new product, share experience, establish status within, provide solution…

General Design Logic

Describe problem at hand
- General/broad topic
- Narrow down gradually
Analyze need

Initialize the local project

Configuration

Add a source code button

Deployment

Purpose:

Main Test Framework

Set the Period of Clock

Set the `core_area` and `die_area`

Collect data and export to `.csv`

Result

Basic

Useful tools

Hello world

Add new building

Reference

Git Merge

Solve conflict

Tools

Commands

Setup of mod

Write Block Scripts

Catalog

Course Introduction

Common Tenses and Voices

Writing Email

Resume

Peer-reviewed Article Publishing

Citation

Technical Project Deliverables

Archives

Recents

Tags

Initialize the local project

Configuration

Add a source code button

Deployment

Purpose:

Main Test Framework

Set the Period of Clock

Set the core_area and die_area

Collect data and export to .csv

Result

Basic

Useful tools

Hello world

Add new building

Reference

Git Merge

Solve conflict

Tools

Commands

Setup of mod

Write Block Scripts

Catalog

Course Introduction

Common Tenses and Voices

Writing Email

Resume

Peer-reviewed Article Publishing

Citation

Technical Project Deliverables

Archives

Recents

Tags

Set the `core_area` and `die_area`

Collect data and export to `.csv`