1_WritePaper
Please follow the following steps when you start writing a paper: Note that the following guidelines are applicable for writing IEEE Transaction papers. I attached a few class notes for a class I took before. Go over it and I believe it is helpful - please do not distribute. I attached one of my journal papers as an example.
Download a Template here to start with. Read it carefully, especially the format for tables and figures. Please follow the IEEE Editorial Style Manual for Authors.
Please do NOT use MathType , instead, use word insert EQUATIONS as WORD does not support MathType well across different versions.
Read the "common bugs in writing" - it can be downloaded from the attached files at the end of this page.
If use Latex, please use overleaf.
For journal publication, I normally recommend the students to publish in the following Journals:
IEEE Transactions on Smart Grid (_folder_)
IEEE Transactions on Sustainable Energy
Applied Energy
IEEE Transactions on Power Systems
IEEE Transactions on Industry Informatics
IEEE Transactions on Transportation Electrification
Writing Tips
Before you send me your paper for revision, please make sure that you go through the check list to make sure that your paper is written in standard IEEE paper format. (Those guidelines are mostly from the IEEE journal paper guidelines. Please read the attached "Preparation of Papers for IEEE TRANSACTIONS and JOURNALS" carefully! As I found many of you do not follow these guidelines.)
1. How to write a technical paper?
Youtubers:
Writing a journal paper by Shady Attia: https://www.youtube.com/watch?v=h4YyoRhRGcQ
Workshop slides: https://docs.google.com/presentation/d/1Zw69HZDY_KbnE49fhCHTeeQKteqRMC_yrD3EAgvA5qU/edit#slide=id.p7
You can use Latex: Overleaf is open to NC state students: Here is a message from Dan Green. We now have a departmental site license for the online service which all of our faculty, researchers, and students may now take advantage of. To use the online option, go to https://www.sharelatex.com in your favorite web browser. If this is your first time on the site, you will be asked to register with an email and a password. Signup with your unityID@ncsu.edu email address. We have preapproved all departmental faculty and students using these email addresses. However, we'd recommend that you NOT use your Unity password for this service. Course instructors should be aware that we've licensed everyone enrolled in an ECE course as well -- so feel free to instruct your course to make use of this service. Even the Physics student in your class is licensed, for as long as he's enrolled in our courses. In addition, our license allows you to invite any number of collaborators -- so you can work with a collegue at another EDU even though they might not also have this site license. Latex Math Symbols
Please do your homework by browsing some writing tips. An example site: Tips for Writing Technical Papers
Download the IEEE standard paper format and make sure your follow each instructions. Pay special attentions to how figures, tables, and reference should be formatted. Note that journal paper and conference paper may have different formats
Abstract: more than 150 but not to exceed 250 words. Please try to use a standardized format which saves you time and trouble to think everytime for how to write it. An example is given here. "This paper presents __________ that _______ based on _____ considering _______. The formulation of _____ is described using _____ an example. The __ is modeled by _; ___ is modeled with _ methods. The models are used to ___. Then, a___ algorithm is used to solve ___. The simulation results demonstrate that __. The algorithm can be used in __ to help ____. "
**************************************************
Find a good title -
Abstract
Index Terms
Section I: Introduction
Section II: Methodology
Section III:Modeling Results.
Present the results obtained using your method by tables, figures, etc.
Follow the IEEE paper format
Titles must be illustrative
Lines and texts in the figures must be eligible
I prefer mark each lines than using legends
compare your method with other approaches
Optimality, convergence, etc.
Section IV: Conclusions.
summarize the findings
future research directions.
Reference
Do follow the standard format required by IEEE
For an original paper, you can have 10-15 reference; for follow-up work or closing the gaps in other research work, you need maybe 25+.
Abstract Examples
This paper presents a novel XYZXYZXYZ approach for XYZ using XYZ data as inputs. To do XYZ (goal), we formulate an XYZ problem to do XYZ (method). Describe the process of the method. First, we utilize ______. Second, we employ ___ to ______. The obtained ___ are ___ by ____ followed by _______. The proposed method is developed and tested using ____ data. Simulation results show that the proposed method outperforms existing methods across various ____, showing X% of increase in ___ and Y% increase in ____.
Index Terms: Enter keywords or phrases in alphabetical order, separated by commas. Alpha-beta order!
Nomenclature
Nomenclature should be listed in Alpha-beta order and don't forget to show the unit of the variable!
Section I: Introduction: not to exceed 1.5 page.
Paragraph 1: why is the solving of the problem is important? (reference to reports and statistics for showing importance)
Paragraph 2 and 3: Which methods have been proposed to solve the problem and what has been solved and what still need improvements? (literature review for the state-of-the art)
Paragraph 4: What method you will propose in this paper? what level of improvement your algorithm can made compare to the exiting approach? You need to set up the stage for your solution method and state contributions. Is this method a completely new method? Is it an extension of an existing method? Is this method used in other domain and you are the first to use it in this domain?
Paragraph 5: Summary of contributions
Paragraph 6: outline of the paper. Here is an example of this part.
The rest of the paper is organized as follows. Section II introduces/presents/describes _______(e.g. modeling methodology, data) and Section III introduces/presents/describes _____(e.g. control algorithms, Problem formulations). The simulation results are presented/discussed in Section IV. The conclusions and future work are included in Section IV.
This paper presents the simplified HVAC model in Section II and introduces the control algorithm for providing ancillary services in Section III. The modeling results are discussed in Section IV. The conclusions and future work are summarized in Section V.
Section II: Modeling Methods.
Introduce the assumptions, data used, modeling tools, model setup
Introduce the models and algorithms used (flow charts, equations)
Introduce the considerations, case setups, performance metrics
Include a flow chart will always be helpful for readers to understand your algorithms.
Flow chart that illustrates the process of your algorithm.
Way 1: Use a flow chart that shows how algorithm works (This representation is also good for patent applications).
Using variables to show detailed logic flow of your algorithm or in a few illustrative blocks to show an overview of your algorithm (how many steps and how each steps connected with each other.
Way 2: Describe the steps in steps
Way 3: Use pseudocodes
Equations
There are different ways to illustrate your algorithms. But in general, you need to make sure the other researchers can follow and reproduce your results.
Use word insert equations - do not use mathtype.
Equation Example 1
\begin{IEEEeqnarray}{rcl}
\label{eqn12}
M_{predicted} (i)=
\begin{cases}
1, & \text{if}\ M_{predicted}(i)=M_{optimal}(i) \\
0, & \text{otherwise}
\end{cases}
\end{IEEEeqnarray}
Equation Example 2
(Please make sure you check all the following rules are met) (Reference to EquationExample3.pdf and EquationExample4.pdf. Can be downloaded at the end of this page)
Number equations consecutively with equation numbers in parentheses flush with the right margin, as in (1)
Punctuate equations when they are part of a sentence
Be sure that the symbols in your equation have been defined before the equation appears or immediately following
Italicize symbols. T might refer to temperature, but T is the unit tesla
Refer to “(1),” not “Eq. (1)” or “equation (1),” except at the beginning of a sentence: “Equation (1) is ... .”
Use parentheses to avoid ambiguities in denominators.
List the variables and don't forget to which units you are using. If you use WORD, you might want to use the insert equations instead of using Mathtype as word does not support mathtype well sometimes. Pick the right size of the text!
Figures:
I need to check each figure carefully to make sure you follow the rules and here are a few things you can do to make my life easier... So I can live a longer and happier life...
I prefer you draw flowcharts or illustrative figures in powerpoint so it is easier for me to edit on and be included in future presentations.
When referencing your figures and tables within your paper, use the abbreviation “Fig.” even at the beginning of a sentence.
In the title use Fig. 1. Note that “Fig.” is abbreviated. There is a period after the figure number, followed by two spaces. (I cannot believe how many students ignored this rule)
When "Figure 1" is at the beginning of a sentence, it is written as "Figure 1" instead of "Fig. 1".
It is good practice to explain the significance of the figure in the caption.
Check to see if your xlabel and ylabel are correct (variable (unit)). variables: Need to italize the variables and include unit
font size: need to be eligible and at least 80% of the figure title. Use the following MATLAB code to set font size (14 or 16 or 18) for small figures (2.5")
figure(1)
set(gcf,'DefaultAxesFontSize',16)
set(gcf,'DefaultTextFontSize',16)
check width and color of the line
make sure the legends are correct
You can use legend to label the lines (Fig. 3) or mark the lines in the figure. When you have more than three lines, I suggest you mark the lines, as shown in Fig. 4.
Tables
I prefer you put the table in EXCEL and email it to me together with the paper so I can edit on it.
Do not abbreviate “Table.” Tables should be numbered with Roman Numerals.
title: TABLE I
Variables need to be written as variables not texts and don't forget the units.
If you have a side note, use "*" and include them in the title as show in this example.
make sure your table is compact and don't make the font too small. 8 is a good font size.
A shot bio and your picture.
please take a picture that is professional and show your face well. :-) Pictures taken in a work place is fine. But you better dress up professionally.
Example of the short bio: Ning Lu (M'98--SM'05) received the B.S. degree in electrical engineering from the Harbin Institute of Technology, Harbin, China, in 1993, and the M.S. and Ph.D. degrees in electric power engineering from Rensselaer Polytechnic Institute, Troy, NY, USA, in 1999 and 2002, respectively. Dr. Lu is currently a professor with the Electrical and Computer Engineering Department, North Carolina State University. She was with Pacific Northwest National Laboratory. Her current research interests include microgrid modeling and control, power distribution systems operation and planning, and power system data analysis.
Other recommendations
When expressing a range of values, write “7 to 9” or “7-9,” not “7~9.”
Indicate sample dimensions as “0.1 cm ´ 0.2 cm,” not “0.1 ´ 0.2 cm2.”
A parenthetical statement at the end of a sentence is punctuated outside of the closing parenthesis (like this). (A parenthetical sentence is punctuated within the parentheses.)
In American English, periods and commas are within quotation marks, like “this period.” Other punctuation is “outside”!
Avoid contractions; for example, write “do not” instead of “don’t.” The serial comma is preferred: “A, B, and C” instead of “A, B and C.”
Use italics for emphasis; do not underline.
Hyphenate complex modifiers: “zero-field-cooled magnetization.”
The word “data” is plural, not singular.
A graph within a graph is an “inset,” not an “insert.”
Use the word “whereas” instead of “while” (unless you are referring to simultaneous events).
Prefixes such as “non,” “sub,” “micro,” “multi,” and “ultra” are not independent words; they should be joined to the words they modify, usually without a hyphen.
There is no period after the “et” in the Latin abbreviation “et al.” (it is also italicized).
The abbreviation “i.e.,” means “that is,” and the abbreviation “e.g.,” means “for example” (these abbreviations are not italicized).
Author photographs is exactly 1 inch wide by 1.25 inches tall (25.4 millimeters x 31.75 millimeters / 6 picas x 7.5 picas)
Acknowledge the funding agencies. We will be in trouble if you don't thank our sponsors :-)
Response to Reviewers’ Comments
First, you want to appreciate the efforts the editor and reviewers put into reviewing your paper. Then, an itemized response must be provided to the reviewers' comments . Lastly, all revisions made to the main manuscript need to be highlighted.
An example for the opening
We sincerely thank the editors and the reviewers for their valuable and constructive feedback. The paper has been carefully revised to address those comments. Note that the revisions made in the main manuscript are highlighted in blue and the itemized responses are provided in this document..
An example response to literature review. I highlight suggest all students provide a table to highlight the advantages and disadvantages in a table format. Once asked, you can add the papers to the right category
Thank you for your insightful suggestion. We have carefully revised the literature review sections to include additional references and have made efforts to cite the recommended papers, providing more in-depth discussions. Acknowledging the abundance of publications in ___, we would like to emphasize that our paper specifically concentrates on_______ methods that ______. Consequently, our comparisons are primarily centered around this particular subcategory to maintain focus and relevance. (Do NOT included the revised texts in the response letter, as the reviewers need to refer to the main manuscript to ensure their relevancy. )
When asked to make changes to assumptions or statements.
Thank you for your valuable suggestion. We have implemented your feedback by including a statement in Section II.A, explicitly outlining our assumptions and the rationale behind them, to address your comments.
An example for requesting revisions to the quality of the figures, font size of figure labels and text in the table. (To begin with, your font size in figure and table should not be smaller than size 7 or 80% of the title text.
Author response: Thank you for your comment. We have updated data in figures X, Y, Z, and tables XYA. (Do NOT included the revised figures in the response letter, as the reviewers need to refer to the main manuscript to ensure their proper presentation. )