Skip to content

Merge latest dev. #19

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Apr 18, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 4 additions & 3 deletions pct/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# Book settings
title : PowerCyber Training # The title of the book. Will be placed in the left navbar.
author : Hantao Cui & Xin Fang # The author of the book
copyright : "2024" # Copyright year to be placed in the footer
copyright : "2024-2025" # Copyright year to be placed in the footer
logo : logo.png # A path to the book logo

# Force re-execution of notebooks on each build.
Expand All @@ -32,7 +32,7 @@ bibtex_bibfiles:

# Information about where the book exists on the web
repository:
url: https://github.com/cuihantao/PowerCyber Training # Online location of your book
url: https://github.com/PowerCyberTraining/powercybertraining.github.io # Online location of your book
path_to_book: docs # Optional path to your book, relative to the repository root
branch: main # Which branch of the repository should be used when creating links (optional)

Expand All @@ -41,4 +41,5 @@ repository:
html:
use_issues_button: true
use_repository_button: true

comments:
hypothesis: true
1 change: 0 additions & 1 deletion pct/_toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ format: jb-book
root: intro
chapters:
- file: how-to-use.md
title: How to use this book
- file: modules/01/intro.md
sections:
- file: modules/01/wsl.ipynb
Expand Down
5 changes: 0 additions & 5 deletions pct/content.md

This file was deleted.

33 changes: 31 additions & 2 deletions pct/how-to-use.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,37 @@

# How to use this book
# How to Follow the Training

This book is designed to be *interactive* and *hands-on*. To get the most out of your learning experience, we recommend the following approach:

## Navigating This Website

This website is designed for easy navigation:

- The **left sidebar** contains the table of contents with collapsible sections for each topic area.
- The **right side** displays the current page content.
- Use the **Next** and **Previous** links at the bottom of each page to move sequentially through lessons.
- In the top-right corner, you'll find buttons for **full screen mode**,
**dark/light mode**, and other display options to customize your reading
experience.

## Highlighting and Annotating using Hypothesis

This website supports **Hypothesis**, an annotation overlay that allows you to
highlight text and add notes. Simply select any text to highlight it and add
your questions or thoughts. This feature is great for collaborative learning
and asking questions about specific content.

```{admonition} Note
:class: tip

You will need to create a free account with Hypothesis to use this feature.

```

You can open the Hypothesis panel
by clicking the "<" button in the top-right corner of the page. The other two
buttons below allows you to switch on and off the highlights and write notes for
the page.

## Setting up your environment

1. **Begin with Module 1**: Start by following the environment setup instructions in Module 1, which will guide you through installing necessary tools (WSL for Windows users, command-line basics, package managers, and development environments).
Expand Down
31 changes: 25 additions & 6 deletions pct/intro.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,38 @@
# PowerCyber Training

Welcome to the PowerCyber Training website!
Welcome to the PowerCyber Training website! We are glad to see you here!

This initiative aims to advance power engineering by providing extensive training in state-of-the-art cyberinfrastructure (CI) technologies. It seeks to empower researchers and professionals with the requisite expertise for innovation in this dynamic field. The workshop is organized around three core objectives to foster a comprehensive grasp of theoretical and practical aspects of power engineering and CI.
This website hosts training materials for power engineering researchers to learn
about modern cyberinfrastructure (CI) technologies. The goal is to equip
researchers with the skills to apply CI technologies for research advancement.
These lessons are designed to be hands-on and self-paced,
meaning that you can work through them by running the code examples and
following the explanations.

This is an ongoing project, and materials will be added and updated regularly.
Lessons are being updated to include an information table at the beginning. The
table will indicate the status of the lesson (e.g., "In Progress", "Completed").
We thank you for your patience as we work to complete the materials.

To start, please click on the "Next" link at the bottom of this page. You can
also use the arrow key on your keyboard to navigate through the website.

The contents of this book are licensed for free consumption under the following
license: Creative Commons Attribution-NonCommercial-NoDerivatives 4.0
International (CC BY-NC-ND 4.0).

# Acknowledgements
```{admonition} Acknowledgements

This work is supported by the National Science Foundation (NSF) under [Grant No.
2319895 and 2319896](https://www.nsf.gov/awardsearch/showAward?AWD_ID=2319895). Any
opinions, findings, and conclusions or recommendations expressed in this
material are those of the author(s) and do not necessarily reflect the views of
the National Science Foundation.
```

```{admonition} License

The contents of this book are licensed for free consumption under the following
license: Creative Commons Attribution 4.0 International (CC-BY-4.0). We welcome
you to share and adapt the contents for your own purposes, provided that you
properly credit the original authors.

![Creative Commons Attribution 4.0 International License](https://i.creativecommons.org/l/by/4.0/88x31.png)
```
54 changes: 0 additions & 54 deletions pct/markdown-notebooks.md

This file was deleted.

56 changes: 0 additions & 56 deletions pct/markdown.md

This file was deleted.

10 changes: 5 additions & 5 deletions pct/modules/01/intro.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Tools You Need
# Computational Environment Fundamentals

## Motivation

Expand All @@ -9,7 +9,7 @@ researchers to figure out how to install, configure, and efficiently use these
tools for research.

Most power engineering researchers are familiar with the Microsoft Windows
operating system and the MATLAB software. However, many of the advanced
operating system and probably also with MATLAB. However, many of the advanced
cyberinfrastructure tools are developed on Linux and thus compile more easily
and run more efficiently in Linux. On the other hand, compiling and configuring
some tools to properly run on Windows may take significantly more efforts.
Expand All @@ -19,8 +19,8 @@ important for research productivity.
This module aims to provide an introduction to several tools on Linux. These
include
- Windows Subsystem for Linux (WSL)
- Shell
- Anaconda/Mambaforge
- VS Code
- Linux Command Line Interface (CLI)
- Python Package Management
- Visual Studio Code IDE
- Jupyter Notebook
- git
Loading