From 5e771ca1ba490a5a543b64e24a8afb97f15b9b9a Mon Sep 17 00:00:00 2001 From: jz8u17 <j.zhan@soton.ac.uk> Date: Thu, 8 Apr 2021 12:54:47 +0100 Subject: [PATCH] Update ReadMe --- README.md | 2 +- model/README.md | 15 ++++++++------- 2 files changed, 9 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 9ee7dec..e638694 100644 --- a/README.md +++ b/README.md @@ -20,4 +20,4 @@ Presentations and results can be found in the [paper](https://ieeexplore.ieee.or ## Usage - The CCS project is developed upon MSP430FR6989, can be directly imported to CCS. -- For usage of the two models, please see README files in each [model](https://git.soton.ac.uk/energy-driven/energy-storage-sizing/-/tree/master/model) and [finegrain](https://git.soton.ac.uk/energy-driven/energy-storage-sizing/-/tree/master/finegrain) subfolders. \ No newline at end of file +- For usage of the two models, please see README files in each [model](model/) and [finegrain](finegrain/) subfolders. \ No newline at end of file diff --git a/model/README.md b/model/README.md index b108384..faa7cb0 100644 --- a/model/README.md +++ b/model/README.md @@ -1,5 +1,6 @@ # Introduction +This folder contains a set of command line programs that explores the sizing effect of energy storage and energy harvester given constant current and real-world energy conditions. # Build and run @@ -25,21 +26,21 @@ cd bin/ ## stor_constcurrent -This is a program that outputs forward progress against supply current and energy storage capacitance, as well as maximum forward progress that can be achieved with each supply current. -The progrom prompts user input for the test ranges of capacitance and supply current. +This is a program that outputs forward progress against supply current and energy storage capacitance, as well as maximum forward progress that can be achieved with each supply current. +The progrom prompts user input for the test ranges of capacitance and supply current. For example: ``` -Please enter c_min c_step c_no (int int int, 'uF'): +Please enter c_min c_step c_no (int int int, 'uF'): 7 1 93 -Please enter i_min i_step i_no (double double int, 'mA'): -0.1 0.1 3 +Please enter i_min i_step i_no (double double int, 'mA'): +0.1 0.1 3 ``` -This will test 7-99 uF capacitance and 0.1-0.9 mA supply current. +This will test 7-99 uF capacitance and 0.1-0.9 mA supply current. ## rs_to_ram The file name 'rs_to_ram' is short for 'Restore/Save Time Overheads scaled by RAM usage'. -This program explores the impact of different restore/save time overheads. +This program explores the impact of different restore/save time overheads. Restore/save time overheads should be linear to the state size. ## harv_stor -- GitLab