Skip to main content
Intelligent Economics: An Explainable AI Approach
SearchLoginLogin or Signup
Published on May 04, 2022

Tech Editor Instructions

Econ 211 Autumn Project 4

by Luyao (Sunshine) Zhang, Xinyu (Michelle) Tian, Zesen Zhuang, Luyao (Sunshine) Zhang, Xinyu (Michelle) Tian, Tianyu (Henry) Wu, Jingwei Li, Chenyu (Claire) Wang, and Zesen Zhuang
Published onMay 04, 2022
Tech Editor Instructions
·

About

For writing in emerging fields and interdisciplinary disciplines, writing skills are no longer the only need. The new era of research requires an increasing number of writing techniques to be mastered. This article introduces some of the software and platforms that are needed for writing, typesetting as well as content creating, and provides some relevant references.

resources:

Table of Contents

1. Languages

1.1 LaTex

1.2 Markdown

2. Recommended Writing Platforms/Softwares

3. Other Platforms/Softwares

1. Languages

1.1 LaTex

It is highly recommended to use Latex when you’re intended to type professional-looking mathematical expressions, algorithms with pseudo-code, and tables. You can take a screenshot and copy-paste the output to your text editor.

  • [QuickStart] Watch this YouTube video to get a quick overview of Latex.

  • [Overleaf Latex Guideline] Here you can find a comprehensive Latex tutorial provided by Overleaf. You should be able to find any other Latex format guidelines here if not provided below.

  • Language Basic

    • [Structure] Latex document structure guideline.

    • [Symbols] Reference for frequently used symbols in mathematical expressions.

    • [Fonts] Use different fonts in mathematical expressions.

  • Latex Application Scenarios

    • [Images] Insert images in Latex.

    • [Expressions] Type mathematical expressions in Latex.

    • [Tables] Create tables in Latex. To create professional-looking Latex tables, package booktabs is recommended [booktabs tutorial].

    • [Algorithms] Generate pseudo-code in Latex. Check algorithmicx package documentation for more information. See [Algorithm Template] for a template.

    • [Bibliography] BibTeX supports auto-generated in-text citation and bibliography entries in various styles. You can first use reference management software mybib to collect bibliography information; then you’re able to directly download the whole bibliography file, and then load it into your project and cite them. Here is the sample of the [mybib project folder] and [overleaf] where we included instruction for citation in Latex.

    • [Author/Affiliation/Thanks] Use authblk package to add author/affiliation information to the beginning of your article.

  • How to troubleshoot

    • When you encounter a problem that is difficult to solve, consulting the official documentation is always the ultimate solution. The official documentation will not only give many code examples but also solutions to some common compatibility issues.

    • Here are a few additional websites that provide easy access to search solutions:

1.2 Markdown

Markdown is an easy-to-use language standard that allows you to create structured documents. Check [Markdown Tutorial] to get started with Markdown.

  • Language Basic

    • [Markdown Guideline] The syntax for Markdown language is very simple. Check the link for a quick syntax reference.

2. Recommended Writing Platforms/Softwares

3. Other Platforms/Softwares

  • [Google Colab] (Interactive Ipython Notebook) (Online) Google Colab is a platform to quickly create and run python code. You might use Colab to demonstrate your Python module/code snippet. Watch this [YouTube Video] to get started.

  • [GitHub Readme] A README file is an introductory file to your project, often displayed on the main page of your GitHub repository. Check [This Website] for guidelines to write a good README file. The GitHub README file supports most Markdown language features. However, some functions like a table of contents are not supported. Check [This Website] for instructions.

  • [PyPI] (Python Package Hub) (Online/Command Line) PyPI is an online Python package hub where you can download Python modules or wrap up and upload your own.

    • [pip] pip is a package manager for Python. Watch this [YouTube Video] to get started.

    • [twine] twine is a package used to upload and publish PyPI packages. Check our [Instruction] for package wrapping and uploading. Or you can watch this [YouTube Video] for a live demo.

  • [OpenAI] The OpenAI Python library provides easy-to-use functionalities for machine learning which is a good place for beginners.

    • [gym] gym provides famous reinforcement learning environments and algorithms. Watch this [YouTube Video] to start to play around with it. Check [This Website] for documentation for gym.

    • Check this [Documentation] for other features of the OpenAI Python library.

  • [ReadtheDocs] ReadtheDocs is a platform and toolkit for software documentation building and hosting. Check [This Website] for tutorial

  • [Medium] Medium is an online publishing platform, having a hybrid collection of amateur and professional people and publications. Check [This Website] for a tutorial.

    • Embed directly in medium:

      • To embed code directly in medium, the following shortcut key can be used:

      • Mac: Command + Option + 6

      • Windows: Control + Alt + 6

      • Linux: Control + Alt + 6

      • When you press these keys, a grey box as below will appear, inside which you can write your code.

    • Embed using Github Gist

      • Github Gist is a much more appealing and readable option compared to directly embedding using Medium. Check [This Website] for a tutorial.

Examples:

Kaggle, Colab, and Notion (Tian, 2021)

Nested Dictionary, Colab, and Notion (Zhuang, 2021)

Time Series Data, Colab, and Notion (Wu, 2021)

ICO Data, Colab, and Medium (Wang, 2021)

Time Series Data, Colab, and Medium (Li, 2021)

License
Creative Commons Attribution-ShareAlike 4.0 International License (CC-BY-SA 4.0)
Comments
1
?
Login to discuss
?
Mahima Mantri:

Great post. Thanks for sharing. Attend The Best Tableau Certification Training In Pune From Sevenmentor. Practical Tableau Training Sessions With Assured Placement Support From Experienced Faculty.

Visit: Tableau Course in Pune

Intelligent Economics: An Explainable AI Approach
Published with