diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 98f65e8..4c4b1f1 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -19,12 +19,12 @@ repos: - id: check-yaml - repo: https://github.com/python-jsonschema/check-jsonschema - rev: 0.29.4 + rev: 0.30.0 hooks: - id: check-github-workflows - repo: https://github.com/sirosen/texthooks - rev: 0.6.7 + rev: 0.6.8 hooks: - id: fix-smartquotes - id: fix-spaces @@ -55,6 +55,6 @@ repos: exclude: shortcodes|plugins|CODE_OF_CONDUCT.rst - repo: https://github.com/executablebooks/mdformat - rev: 0.7.18 + rev: 0.7.21 hooks: - id: mdformat diff --git a/LICENSE.md b/LICENSE.md index 90e2d69..8f16813 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -2,7 +2,7 @@ Source code files and code snippets included in this project are licensed under a [BSD 3-clause license with a patent -grant](#bsd-3-clause-license-with-patent-grant). All other content in +grant](#bsd-3-clause-license-with-patent-grant). All other content in this project, including content produced directly from unmodified source code and code snippets, is licensed under a [Creative Commons Attribution 4.0 International (CC BY 4.0) diff --git a/README.md b/README.md index 0333aea..b91cc02 100644 --- a/README.md +++ b/README.md @@ -8,7 +8,7 @@ This repository contains the code for the Plasma Hack Week website The [contribution guide](https://github.com/PlasmaPy/plasmapy.github.io/blob/src/CONTRIBUTING.md) for PlasmaPy's main website contains instructions on how to contribute -to the Plasma Hack Week website. These instructions include how to fork +to the Plasma Hack Week website. These instructions include how to fork and clone the repository, how to build local copies of the website, etc. ## License diff --git a/pages/2021/about.md b/pages/2021/about.md index 3d63495..636f81e 100644 --- a/pages/2021/about.md +++ b/pages/2021/about.md @@ -26,13 +26,13 @@ hidetitle: True

-Welcome to the inaugural **Plasma Hack Week**!! Our first event will be held -remotely from June 28 - July 2, 2021. The event is **free** and sets out to +Welcome to the inaugural **Plasma Hack Week**!! Our first event will be held +remotely from June 28 - July 2, 2021. The event is **free** and sets out to increase awareness of open-source software for the Plasma Community: the benefits it can have on the community, what is currently available, and -how to foster community development of open-source software. As such, topics will +how to foster community development of open-source software. As such, topics will range from demonstrating and using current open-source plasma software projects -to software engineering skills. These topics will be presented through both +to software engineering skills. These topics will be presented through both structured learning activities, such as guided tutorials, and unstructured project time for collaborative learning. diff --git a/pages/2021/exit_survey.md b/pages/2021/exit_survey.md index 4ac8b1b..340a3c5 100644 --- a/pages/2021/exit_survey.md +++ b/pages/2021/exit_survey.md @@ -3,9 +3,9 @@ hidetitle: True # Plasma Hack Week 2021: Exit Survey -Thank you for join us for our first Plasma Hack Week! We were amazed -by the interest and support of the community. However, as it goes with -any development, there is always room for improvement. As such, we +Thank you for join us for our first Plasma Hack Week! We were amazed +by the interest and support of the community. However, as it goes with +any development, there is always room for improvement. As such, we would like to hear your thoughts on the event, so we can make it even better for next year! diff --git a/pages/2021/install.md b/pages/2021/install.md index e63f87c..5eaacfd 100644 --- a/pages/2021/install.md +++ b/pages/2021/install.md @@ -4,7 +4,7 @@ hidetitle: True # Software Installation for Plasma Hack Week This page contains instructions for installing software to be used -during Plasma Hack Week. In addition, here are installation links for +during Plasma Hack Week. In addition, here are installation links for - [BOUT++](https://bout-dev.readthedocs.io/en/latest/user_docs/installing.html) - [Gkeyll](https://gkeyll.readthedocs.io/en/latest/install.html) @@ -36,7 +36,7 @@ Week. 1. Download this [`environment.yml`](https://raw.githubusercontent.com/PlasmaPy/hack-week-2021/main/environment.yml) - file to the `hackweek` folder. You might need to use the "save page + file to the `hackweek` folder. You might need to use the "save page as" option from your web browser menu. 1. [Open Anaconda @@ -56,7 +56,7 @@ Week. - Click "Import". 1. Under the "Environments" tab on Anaconda Navigator, find the - `hackweek` environment. Click on the arrow for that environment, and + `hackweek` environment. Click on the arrow for that environment, and select the option to "Open with Jupyter Notebook". 1. After Jupyter Notebook opens in your web browser, click on the button @@ -68,7 +68,7 @@ Week. import plasmapy ``` - and then press shift-Enter to execute the cell. This should run + and then press shift-Enter to execute the cell. This should run without giving any errors. ### Installation with `conda` from the command line @@ -79,7 +79,7 @@ If you have a working installation of `conda` then you can install the 1. Open a terminal. 1. Create a folder on your computer for the Hack Week, which we'll call - `hackweek`. Enter that folder. + `hackweek`. Enter that folder. 1. Download the `environment.yml` file by running @@ -121,7 +121,7 @@ Binder environment to access a Python environment from your web browser. ## Integrated development environments An integrated development environment (IDE) is software used for code -development. IDEs typically include a source code editor as well as +development. IDEs typically include a source code editor as well as built-in tools for refactoring, version control, running tests, and debugging. @@ -136,7 +136,7 @@ debugging. ## Unix shell Python and `git` are often used from the Unix shell, which is one of the -most commonly used command line interfaces. Here are instructions on +most commonly used command line interfaces. Here are instructions on [installing and/or accessing the bash shell](https://carpentries.github.io/workshop-template/#shell), which is one of the most commonly used Unix shells. diff --git a/pages/2021/python.md b/pages/2021/python.md index d806c72..59d0482 100644 --- a/pages/2021/python.md +++ b/pages/2021/python.md @@ -5,14 +5,14 @@ hidetitle: True In the week before the Hack Week, we hosted two tutorials to introduce [Python](https://www.python.org/) to students and scientists -who are new to Python. These tutorials were held on Monday, June 21 -and Tuesday, June 22 at 15 UTC (5 pm CEST / 11 am EDT / 8 am PDT). Each -tutorial lasted about an hour. This tutorial was adapted from +who are new to Python. These tutorials were held on Monday, June 21 +and Tuesday, June 22 at 15 UTC (5 pm CEST / 11 am EDT / 8 am PDT). Each +tutorial lasted about an hour. This tutorial was adapted from Software Carpentry's [Programming with Python tutorial](https://swcarpentry.github.io/python-novice-inflammation/). To replicate the Python environment for this tutorial, please go to the -following Binder link. You can access the Jupyter notebook used for the +following Binder link. You can access the Jupyter notebook used for the tutorial by opening `PythonIntro2021.ipynb`. [![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/PlasmaPy/hack-week-python-intro/HEAD) @@ -62,7 +62,7 @@ please follow these instructions. "Jupyter Notebook". 1. Under the "Environments" tab on Anaconda Navigator, click on the - arrow for the `base` environment. Select "Open terminal". + arrow for the `base` environment. Select "Open terminal". 1. Type `pip install numpy matplotlib` to install the necessary packages and press enter. @@ -86,8 +86,8 @@ please follow these instructions. matplotlib.pyplot.show() ``` - Press shift-enter to run the cell. If you get a fancy plot, you're - all set! If you run into any errors, please ask on the + Press shift-enter to run the cell. If you get a fancy plot, you're + all set! If you run into any errors, please ask on the [Discord channel for the Hack Week](https://discord.gg/HdsZkp9M35) in the `#tutorial-python` channel. diff --git a/pages/2021/registration.md b/pages/2021/registration.md index 3825dad..88139a0 100644 --- a/pages/2021/registration.md +++ b/pages/2021/registration.md @@ -17,6 +17,6 @@ the Hack Week and tailor topics to your interests, as best as we can, during the unstructured sessions. The registration form has an option to propose a **lightning talk** if you -are interested in giving one. A lightning talk is an informal ∼5 minute -talk on any topic of interest to Hack Week participants. For more +are interested in giving one. A lightning talk is an informal ∼5 minute +talk on any topic of interest to Hack Week participants. For more information on lightning talks, see the [schedule page](../schedule). diff --git a/pages/2021/schedule.md b/pages/2021/schedule.md index ab4b938..2bbce7e 100644 --- a/pages/2021/schedule.md +++ b/pages/2021/schedule.md @@ -22,12 +22,12 @@ hidetitle: True Each day of **Plasma Hack Week** will be filled with structured tutorial -time, social time, and unstructured free hacking time. All pre-planned +time, social time, and unstructured free hacking time. All pre-planned events will not exceed 5 hours in any given day, and we highly encourage any breakout discussions and hack sessions that may be inspired from the day's activities. -This year's Hack Week will be held from June 28 to July 2. Each day is divided +This year's Hack Week will be held from June 28 to July 2. Each day is divided into two 2-hour sessions split between a social hour, see [the schedule](#the-schedule) below for details. @@ -38,21 +38,21 @@ the option for any inspired discussions as we move into the social hour. Social Hour : The social hour is intended for participants to use as they like, but we highly encourage participants to use this time to interact and discuss -with other participants. During this time the Hack Week organizers +with other participants. During this time the Hack Week organizers will sit in the main meeting to be available for any discussions, but -we will also have several breakout rooms available. These breakout +we will also have several breakout rooms available. These breakout rooms are so participants can have more focused discussions amongst themselves. Second Session : The second session is focused more towards open hacking/coding and -discussions. The session will start off with a specific topic +discussions. The session will start off with a specific topic to get the ball rolling and then will be opened up to any topics participants are interested in. During the social hour or second session we highly encourage participants -to schedule additional events. If this is something you are interested -in, then please announce and organize it on Discord. We will do our best +to schedule additional events. If this is something you are interested +in, then please announce and organize it on Discord. We will do our best to facilitate a breakout room for you. ## The schedule @@ -72,9 +72,9 @@ to facilitate a breakout room for you. ## Prequel tutorials on scientific Python We will hold two [tutorials to introduce Python](../python) to -participants who are new to Python. These tutorials will be held +participants who are new to Python. These tutorials will be held the week before the Hack Week on Monday, June 21 and Tuesday, June 22 at -15 UTC (5 pm CEST / 11 am EDT / 8 am PDT). Each tutorial will last about +15 UTC (5 pm CEST / 11 am EDT / 8 am PDT). Each tutorial will last about one hour. ## Types of talks @@ -85,20 +85,20 @@ one hour. During the Hack Week, we will hold a series of interactive tutorials. Some of the tutorials will be longer (≳1 hr) to allow an in-depth -introduction to a particular software package or technique. Likely +introduction to a particular software package or technique. Likely topics include version control with git/GitHub, how to contribute to an open source software project, getting started with PlasmaPy or OMFIT, -and writing software tests. We will also hold shorter tutorials +and writing software tests. We will also hold shorter tutorials (∼30 min) that will provide an interactive demonstration of the highlights of a particular software package. ### Lightning talks A lightning talk is an informal ∼5 minute talk on any topic of interest -to Hack Week participants. Example topics include a short demo of plasma +to Hack Week participants. Example topics include a short demo of plasma software, a hack week project idea, an upcoming event, a suggestion for improving the culture of the plasma software community, something you learned during the Hack Week, an upcoming event, or an idea for plasma -software that is yet to be developed. The time allowed for each -lightning talk will depend on how many people sign up. There may be +software that is yet to be developed. The time allowed for each +lightning talk will depend on how many people sign up. There may be time during the Hack Week to request a lightning talk as well. diff --git a/pages/2021/social.md b/pages/2021/social.md index 1fb0851..9c315d0 100644 --- a/pages/2021/social.md +++ b/pages/2021/social.md @@ -4,8 +4,8 @@ hidetitle: True # Plasma Hack Week 2021: Social Events Since this year's Hack Week is purely virtual, and as such, we inherently -lose the social aspect related to in-person events. In an effort to regain +lose the social aspect related to in-person events. In an effort to regain some camaraderie, we're currently scheduling social hours for every day of the event and will provide mechanisms so people can split off into -their own working/social groups. Please stay tuned, and we'll update you -with more info. You can also visit our [scheduling page](../schedule). +their own working/social groups. Please stay tuned, and we'll update you +with more info. You can also visit our [scheduling page](../schedule). diff --git a/pages/2022/about.md b/pages/2022/about.md index dd3c9a8..56e0270 100644 --- a/pages/2022/about.md +++ b/pages/2022/about.md @@ -33,22 +33,22 @@ hidetitle: True

-Welcome to the second **Plasma Hack Week**!! This year's Hack Week will be -held remotely from July 11 – July 15, 2022. The event is **free** and will +Welcome to the second **Plasma Hack Week**!! This year's Hack Week will be +held remotely from July 11 – July 15, 2022. The event is **free** and will target three objectives: increasing awareness of open-source software for the Plasma Community; building a contributor base for open-source software within the Plasma Community; and **training our scientists so open-source -software can thrive throughout the Plasma Community**. These objectives will be +software can thrive throughout the Plasma Community**. These objectives will be achieved through a hybrid of structured and unstructured learning activities -that we will do as a collaborative group. So, come prepared to code and have +that we will do as a collaborative group. So, come prepared to code and have fun!!! Based on the feedback from last year's event, we are switching up the -style of the Hack Week. Instead of being predominately presentation focused, -this year we will be focusing on coding together and learning by doing. We +style of the Hack Week. Instead of being predominately presentation focused, +this year we will be focusing on coding together and learning by doing. We will spend the week developing our own `hack` Python package, staring with the basics (`git` and [GitHub](https://github.com/)) and moving through more -advanced topic throughout the week. By the end of the week we should have our +advanced topic throughout the week. By the end of the week we should have our own plasma formulary much like the [`plasmapy.formulary`](https://docs.plasmapy.org/en/latest/formulary/index.html). diff --git a/pages/2022/registration.md b/pages/2022/registration.md index c5432f7..db758ff 100644 --- a/pages/2022/registration.md +++ b/pages/2022/registration.md @@ -17,7 +17,7 @@ the Hack Week and tailor topics to your interests, as best as we can, during the event. The registration form has an option to propose a **lightning talk** if you -are interested in giving one. A lightning talk is a short, informal +are interested in giving one. A lightning talk is a short, informal talk on any topic of interest to Hack Week participants.