From 438845477995cf2361995c624782f66f300150e1 Mon Sep 17 00:00:00 2001 From: Nick Murphy <namurphy@cfa.harvard.edu> Date: Wed, 27 Mar 2024 14:01:09 -0400 Subject: [PATCH 01/13] Add .pre-commit-config.yaml --- .pre-commit-config.yaml | 69 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 .pre-commit-config.yaml diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml new file mode 100644 index 0000000..dfef006 --- /dev/null +++ b/.pre-commit-config.yaml @@ -0,0 +1,69 @@ +ci: + autofix_prs: false + autoupdate_schedule: monthly + +# Specify the default version of Ruby in case it is not installed +default_language_version: + ruby: 2.7.2 + +repos: + +- repo: https://github.com/pre-commit/pre-commit-hooks + rev: v4.5.0 + hooks: + - id: check-merge-conflict + name: check for git merge conflicts + exclude: .*\.rst + - id: check-case-conflict + name: check for filename case conflicts + - id: trailing-whitespace + - id: end-of-file-fixer + - id: check-json + - id: check-toml + - id: check-yaml + +- repo: https://github.com/python-jsonschema/check-jsonschema + rev: 0.28.0 + hooks: + - id: check-github-workflows + +- repo: https://github.com/sirosen/texthooks + rev: 0.6.4 + hooks: + - id: fix-smartquotes + - id: fix-spaces + - id: fix-ligatures + - id: forbid-bidi-controls + +- repo: https://github.com/macisamuele/language-formatters-pre-commit-hooks + rev: v2.12.0 + hooks: + - id: pretty-format-ini + args: [--autofix] + - id: pretty-format-yaml + args: [--autofix] + # For the labeler GitHub Action, labels with spaces in them must + # be put in quotes. However, the pretty-format-yaml hook will + # remove the quotes which will break that action, so we should not + # run this hook on `labeler.yml` (or certain other files). + exclude: .github/labeler.yml|.pre-commit-search-and-replace.yaml + +- repo: https://github.com/mattlqx/pre-commit-search-and-replace + rev: v1.0.5 + hooks: + - id: search-and-replace + exclude: changelog/.*|docs/changelog/.*|.sourcery.yaml|docs/_global_substitutions.py|CHANGELOG.rst + +- repo: https://github.com/codespell-project/codespell + rev: v2.2.6 + hooks: + - id: codespell + name: codespell (add false positives to pyproject.toml) + args: [--write-changes] + additional_dependencies: + - tomli + +- repo: https://github.com/executablebooks/mdformat + rev: 0.7.17 + hooks: + - id: mdformat From 142464963d6316ac94f738198f98c54d6a3ebbcc Mon Sep 17 00:00:00 2001 From: Nick Murphy <namurphy@cfa.harvard.edu> Date: Wed, 27 Mar 2024 14:14:20 -0400 Subject: [PATCH 02/13] Remove codespell action since it's in pre-commit --- .github/workflows/codespell.yml | 33 --------------------------------- 1 file changed, 33 deletions(-) delete mode 100644 .github/workflows/codespell.yml diff --git a/.github/workflows/codespell.yml b/.github/workflows/codespell.yml deleted file mode 100644 index 4302786..0000000 --- a/.github/workflows/codespell.yml +++ /dev/null @@ -1,33 +0,0 @@ -name: Codespell - -on: - push: - branches: - - src - pull_request: - workflow_dispatch: - -jobs: - - spellcheck: - - name: Codespell - runs-on: ubuntu-latest - - steps: - - - name: Checkout code - uses: actions/checkout@v3 - with: - fetch-depth: 0 - - - name: Set up Python - uses: actions/setup-python@v3 - with: - python-version: '3.10' - - - name: Install nox - run: python -m pip install --progress-bar off --upgrade nox - - - name: Run tests - run: nox -s codespell --forcecolor From 8f6e185162c2c0b8f1ed5ef6d5be71f297fe97f4 Mon Sep 17 00:00:00 2001 From: Nick Murphy <namurphy@cfa.harvard.edu> Date: Wed, 27 Mar 2024 14:17:48 -0400 Subject: [PATCH 03/13] Remove pre-commit-search-and-replace --- .pre-commit-config.yaml | 6 ------ 1 file changed, 6 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index dfef006..d670070 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -48,12 +48,6 @@ repos: # run this hook on `labeler.yml` (or certain other files). exclude: .github/labeler.yml|.pre-commit-search-and-replace.yaml -- repo: https://github.com/mattlqx/pre-commit-search-and-replace - rev: v1.0.5 - hooks: - - id: search-and-replace - exclude: changelog/.*|docs/changelog/.*|.sourcery.yaml|docs/_global_substitutions.py|CHANGELOG.rst - - repo: https://github.com/codespell-project/codespell rev: v2.2.6 hooks: From dbfd22c9407b0576c89ef6467e7b2ba90714f176 Mon Sep 17 00:00:00 2001 From: Nick Murphy <namurphy@cfa.harvard.edu> Date: Wed, 27 Mar 2024 14:19:01 -0400 Subject: [PATCH 04/13] Apply pre-commit changes to markdown --- pages/2021/about.md | 12 ++--- pages/2021/exit_survey.md | 2 +- pages/2021/install.md | 99 ++++++++++++++++++++++---------------- pages/2021/python.md | 79 +++++++++++++++++------------- pages/2021/registration.md | 4 +- pages/2021/schedule.md | 48 +++++++++--------- pages/2022/about.md | 9 ++-- pages/2022/registration.md | 2 +- pages/2022/schedule.md | 42 ++++++++-------- pages/index.md | 35 +++++++------- pages/resources.md | 58 +++++++++++----------- 11 files changed, 210 insertions(+), 180 deletions(-) diff --git a/pages/2021/about.md b/pages/2021/about.md index 3ae1bd6..3d63495 100644 --- a/pages/2021/about.md +++ b/pages/2021/about.md @@ -3,7 +3,7 @@ hidetitle: True # Plasma Hack Week 2021 -<div class="plasmapy-note" +<div class="plasmapy-note" style="max-width: 300px; margin-top: 24px; border-style: solid; @@ -26,8 +26,8 @@ hidetitle: True </p> </div> -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 @@ -37,14 +37,14 @@ structured learning activities, such as guided tutorials, and unstructured proje time for collaborative learning. In the week leading up to the **Plasma Hack Week**, a few more fundamentally -focused tutorials will be presented on topics like the basics of Python, using +focused tutorials will be presented on topics like the basics of Python, using version control, contributing to open-source projects, etc. -For information on registering please visit our +For information on registering please visit our [registration page](../registration). For information on the schedule and pre-week tutorials please visit our [scheduling page](../schedule). -For any additional questions please reach out to us on our +For any additional questions please reach out to us on our [Discord channel](https://discord.gg/HdsZkp9M35). diff --git a/pages/2021/exit_survey.md b/pages/2021/exit_survey.md index 5f5ad8d..4ac8b1b 100644 --- a/pages/2021/exit_survey.md +++ b/pages/2021/exit_survey.md @@ -11,7 +11,7 @@ better for next year! <div style="width: 100%; margin: 24px"> <a href=https://docs.google.com/forms/d/e/1FAIpQLSeKNwXWmi0A-RtaYD6RIN1Q2sjFIPKX4Plzy72IPBI0ex2wyg/viewform?usp=sf_link - class="feature-card feature-link btn-plasmapy-bluegreen" + class="feature-card feature-link btn-plasmapy-bluegreen" style="width: 200px"> <div>Exit Survey</div> </a> diff --git a/pages/2021/install.md b/pages/2021/install.md index daaf4cd..e63f87c 100644 --- a/pages/2021/install.md +++ b/pages/2021/install.md @@ -21,80 +21,95 @@ in order to follow along with many of the tutorials. ## Python -### Installation with Anaconda Navigator (recommended) +### Installation with Anaconda Navigator (recommended) The following instructions are designed to help us set up a Python environment with several of the packages to be discussed during the Hack Week. 1. Please follow these instructions for - [installing Anaconda](https://docs.anaconda.com/anaconda/install/). + [installing Anaconda](https://docs.anaconda.com/anaconda/install/). When this is done, you should have Anaconda Navigator installed. -2. Create a folder on your computer for the Hack Week, which we'll call + +1. Create a folder on your computer for the Hack Week, which we'll call `hackweek`. -3. Download this + +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 as" option from your web browser menu. -4. [Open Anaconda + +1. [Open Anaconda Navigator](https://docs.anaconda.com/anaconda/user-guide/getting-started/#open-navigator). -5. Under the "Home" tab on Anaconda Navigator, search for and install + +1. Under the "Home" tab on Anaconda Navigator, search for and install "Jupyter Notebook". -6. [Create an Anaconda environment](https://docs.anaconda.com/anaconda/navigator/tutorials/manage-environments/#importing-an-environment) + +1. [Create an Anaconda environment](https://docs.anaconda.com/anaconda/navigator/tutorials/manage-environments/#importing-an-environment) for the Hack Week. - * Select the "Environment" tab. - * Below the list of environments, click "Import". - * Click the file folder icon. - * Navigate to and select the `environment.yml` (possibly in your - `Downloads` folder). - * Click "Import". -7. Under the "Environments" tab on Anaconda Navigator, find the + + - Select the "Environment" tab. + - Below the list of environments, click "Import". + - Click the file folder icon. + - Navigate to and select the `environment.yml` (possibly in your + `Downloads` folder). + - Click "Import". + +1. Under the "Environments" tab on Anaconda Navigator, find the `hackweek` environment. Click on the arrow for that environment, and select the option to "Open with Jupyter Notebook". -8. After Jupyter Notebook opens in your web browser, click on the button + +1. After Jupyter Notebook opens in your web browser, click on the button for "New", and click on "Python 3" to open a Python notebook. -9. Test the installation by typing - import plasmapy +1. Test the installation by typing + + ``` + import plasmapy + ``` - and then press shift-Enter to execute the cell. This should run - without giving any errors. + and then press shift-Enter to execute the cell. This should run + without giving any errors. ### Installation with `conda` from the command line -If you have a working installation of `conda` then you can install the -`hackweek` environment with the following steps. +If you have a working installation of `conda` then you can install the +`hackweek` environment with the following steps. 1. Open a terminal. -2. Create a folder on your computer for the Hack Week, which we'll call + +1. Create a folder on your computer for the Hack Week, which we'll call `hackweek`. Enter that folder. -3. Download the `environment.yml` file by running - <pre class="code literal-block"> +1. Download the `environment.yml` file by running + + <pre class="code literal-block"> wget https://raw.githubusercontent.com/PlasmaPy/hack-week-2021/main/environment.yml </pre> -4. Run the following command to create the environment. +1. Run the following command to create the environment. - <pre class="code literal-block"> + <pre class="code literal-block"> conda env create -f environment.yml </pre> -5. Activate this environment by running +1. Activate this environment by running - <pre class="code literal-block"> + <pre class="code literal-block"> conda activate hackweek </pre> -6. Test the environment by running +1. Test the environment by running - <pre class="code literal-block"> + <pre class="code literal-block"> jupyter notebook </pre> - In the Jupyter notebook, run + In the Jupyter notebook, run - import plasmapy + ``` + import plasmapy + ``` ### Binder link @@ -107,21 +122,21 @@ Binder environment to access a Python environment from your web browser. An integrated development environment (IDE) is software used for code development. IDEs typically include a source code editor as well as -built-in tools for refactoring, version control, running tests, and -debugging. +built-in tools for refactoring, version control, running tests, and +debugging. -* [PyCharm](https://www.jetbrains.com/pycharm/download) - * Community version is free and open source - * To be used during git & GitHub and clean coding tutorials -* [Visual Studio Code](https://code.visualstudio.com/) - * Community version is free and open source -* [Atom](https://atom.io/) - * Full version is open source +- [PyCharm](https://www.jetbrains.com/pycharm/download) + - Community version is free and open source + - To be used during git & GitHub and clean coding tutorials +- [Visual Studio Code](https://code.visualstudio.com/) + - Community version is free and open source +- [Atom](https://atom.io/) + - Full version is open source ## 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 0ced04b..d806c72 100644 --- a/pages/2021/python.md +++ b/pages/2021/python.md @@ -21,23 +21,23 @@ tutorial by opening `PythonIntro2021.ipynb`. Day 1 - * Python fundamentals - * Reading in data - * [NumPy](https://numpy.org/) arrays - * Plotting with [matplotlib](https://matplotlib.org/) - +- Python fundamentals +- Reading in data +- [NumPy](https://numpy.org/) arrays +- Plotting with [matplotlib](https://matplotlib.org/) + Day 2 - * Loops - * Lists - * Conditionals - * Functions +- Loops +- Lists +- Conditionals +- Functions ## Setup To follow along with these tutorials, you can either install Python on your own computer, or access a Binder link that will create an environment -automatically. +automatically. ### Getting set up on your own computer @@ -47,36 +47,49 @@ please follow these instructions. 1. Please follow these instructions for [installing Anaconda](https://docs.anaconda.com/anaconda/install/). When this is done, you should have Anaconda Navigator installed. -2. Create a folder called `python-intro` on your computer. -3. Download [python-novice-inflammation-data.zip](https://swcarpentry.github.io/python-novice-inflammation/data/python-novice-inflammation-data.zip), + +1. Create a folder called `python-intro` on your computer. + +1. Download [python-novice-inflammation-data.zip](https://swcarpentry.github.io/python-novice-inflammation/data/python-novice-inflammation-data.zip), and move the file to `python-intro`. -4. Unzip `python-novice-inflammation-data.zip` into the `python-intro` + +1. Unzip `python-novice-inflammation-data.zip` into the `python-intro` folder. -5. [Open Anaconda Navigator](https://docs.anaconda.com/anaconda/user-guide/getting-started/#open-navigator). -5. Under the "Home" tab on Anaconda Navigator, search for and install + +1. [Open Anaconda Navigator](https://docs.anaconda.com/anaconda/user-guide/getting-started/#open-navigator). + +1. Under the "Home" tab on Anaconda Navigator, search for and install "Jupyter Notebook". -6. Under the "Environments" tab on Anaconda Navigator, click on the + +1. Under the "Environments" tab on Anaconda Navigator, click on the arrow for the `base` environment. Select "Open terminal". -7. Type `pip install numpy matplotlib` to install the necessary packages - and press enter. -8. Click on the arrow for the `base` environment again. Select the + +1. Type `pip install numpy matplotlib` to install the necessary packages + and press enter. + +1. Click on the arrow for the `base` environment again. Select the option to "Open with Jupyter Notebook". -9. Navigate to the `python-intro` directory, and enter the `data` + +1. Navigate to the `python-intro` directory, and enter the `data` sub-directory. -10. Under the "New" button (probably near the upper right corner), - select "Python 3" to open a notebook. -11. Test the installation by entering - import numpy - import matplotlib.pyplot - data = numpy.loadtxt(fname='inflammation-01.csv', delimiter=',') - matplotlib.pyplot.plot(data) - matplotlib.pyplot.show() +1. Under the "New" button (probably near the upper right corner), + select "Python 3" to open a notebook. + +1. Test the installation by entering + + ``` + import numpy + import matplotlib.pyplot + data = numpy.loadtxt(fname='inflammation-01.csv', delimiter=',') + matplotlib.pyplot.plot(data) + 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 - [Discord channel for the Hack Week](https://discord.gg/HdsZkp9M35) - in the `#tutorial-python` channel. + 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. <!--- ### Binder (no installation required) @@ -86,6 +99,6 @@ online Python environment that you can run from your web browser. [](https://mybinder.org/v2/gh/PlasmaPy/hack-week-python-intro/HEAD) -After the environment initializes, go to the "New" button and select +After the environment initializes, go to the "New" button and select "Python 3" to create a new notebook to use for the tutorial. ---> diff --git a/pages/2021/registration.md b/pages/2021/registration.md index 348534d..3825dad 100644 --- a/pages/2021/registration.md +++ b/pages/2021/registration.md @@ -5,7 +5,7 @@ hidetitle: True <div style="width: 100%; margin: 24px"> <a href=https://docs.google.com/forms/d/e/1FAIpQLScdCs5PgchaE6c9VAEfbyFv9LhOTzM8jLi4v-kroJrTLSv63w/viewform?usp=sf_link - class="feature-card feature-link btn-plasmapy-bluegreen" + class="feature-card feature-link btn-plasmapy-bluegreen" style="width: 200px"> <div>Registration Form</div> </a> @@ -18,5 +18,5 @@ 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 +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 f074b51..ab4b938 100644 --- a/pages/2021/schedule.md +++ b/pages/2021/schedule.md @@ -31,24 +31,24 @@ 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. - First Session - : This session is geared towards tutorials and lightning talks with - 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 - will sit in the main meeting to be available for any discussions, but - 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 - to get the ball rolling and then will be opened up to any topics - participants are interested in. +First Session +: This session is geared towards tutorials and lightning talks with +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 +will sit in the main meeting to be available for any discussions, but +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 +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 @@ -63,7 +63,7 @@ to facilitate a breakout room for you. <iframe src="https://docs.google.com/spreadsheets/d/e/2PACX-1vThxop98ydoJtxUlCzrgtxSgdutLkjSF1zTs4ollIWhgoUxDdpJPh-PV6MegZ8wuc9hLGZSHoueprTr/pubhtml?gid=2076043769&single=true&widget=true&headers=false"></iframe> --> -<iframe +<iframe name="2021HW_schedule" style="width: 100%; height: 700px; overflow: hidden; margin-bottom: 18px" src="https://docs.google.com/spreadsheets/d/e/2PACX-1vThxop98ydoJtxUlCzrgtxSgdutLkjSF1zTs4ollIWhgoUxDdpJPh-PV6MegZ8wuc9hLGZSHoueprTr/pubhtml?gid=2076043769&single=true&widget=false&headers=false&chrome=false&range=A1:H32"> @@ -71,8 +71,8 @@ to facilitate a breakout room for you. ## <a name="prequel"></a> 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 +We will hold two [tutorials to introduce Python](../python) to +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 one hour. @@ -85,10 +85,10 @@ 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. @@ -101,4 +101,4 @@ 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 -time during the Hack Week to request a lightning talk as well. \ No newline at end of file +time during the Hack Week to request a lightning talk as well. diff --git a/pages/2022/about.md b/pages/2022/about.md index 7c27e9a..dd3c9a8 100644 --- a/pages/2022/about.md +++ b/pages/2022/about.md @@ -2,9 +2,10 @@ title: About 2022 Hack Week hidetitle: True # Plasma Hack Week 2022 + **Dates:** July 11 – 15, 2022 -<div class="plasmapy-note" +<div class="plasmapy-note" style="max-width: 300px; margin-top: 24px; border-style: solid; @@ -51,15 +52,15 @@ 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). -For information on registering please visit our +For information on registering please visit our [registration page](../registration). -For any additional questions please reach out to us on our +For any additional questions please reach out to us on our [Discord channel](https://discord.gg/HdsZkp9M35). <!-- In the week leading up to the **Plasma Hack Week**, a few more fundamentally -focused tutorials will be presented on topics like the basics of Python, using +focused tutorials will be presented on topics like the basics of Python, using version control, contributing to open-source projects, etc. For information on the schedule and pre-week tutorials please visit our diff --git a/pages/2022/registration.md b/pages/2022/registration.md index 4a1a49e..c5432f7 100644 --- a/pages/2022/registration.md +++ b/pages/2022/registration.md @@ -5,7 +5,7 @@ hidetitle: True <div style="width: 100%; margin: 24px"> <a href=https://docs.google.com/forms/d/e/1FAIpQLSfRURsxZ3geqs1-1f3ZMUrKtP42uIyDLD0ewfbHBGkVhPgTxQ/viewform?usp=sf_link - class="feature-card feature-link btn-plasmapy-bluegreen" + class="feature-card feature-link btn-plasmapy-bluegreen" style="width: 200px"> <div>Registration Form</div> </a> diff --git a/pages/2022/schedule.md b/pages/2022/schedule.md index e3703d4..f9516b3 100644 --- a/pages/2022/schedule.md +++ b/pages/2022/schedule.md @@ -21,29 +21,29 @@ foundational topics and progress to more advanced topics as the week proceeds. The detailed schedule can be viewed [below](#the-schedule) and the overview is as follows: - Day 1 (foundational) - : The first day focuses on how to set up your system in preparation - for developing open-source Python software. +Day 1 (foundational) +: The first day focuses on how to set up your system in preparation +for developing open-source Python software. - Day 2 (foundational) - : The second day is all about version control with [`git`](https://git-scm.com/) and - [GitHub](https://github.com/about). These are the two primary - tools used to collaboratively develop open-source software. +Day 2 (foundational) +: The second day is all about version control with [`git`](https://git-scm.com/) and +[GitHub](https://github.com/about). These are the two primary +tools used to collaboratively develop open-source software. - Day 3 (intermediate) - : In the third day we start developing our own open-source package, - the [`hack`](https://github.com/PlasmaPy/hack-week) package. To - start the package we'll develop a plasma formulary using the - `plasmapy.formulary` - ([pkg](https://github.com/PlasmaPy/PlasmaPy/tree/main/plasmapy/formulary) | - [docs](https://docs.plasmapy.org/en/latest/formulary/index.html)) - as our guide. +Day 3 (intermediate) +: In the third day we start developing our own open-source package, +the [`hack`](https://github.com/PlasmaPy/hack-week) package. To +start the package we'll develop a plasma formulary using the +`plasmapy.formulary` +([pkg](https://github.com/PlasmaPy/PlasmaPy/tree/main/plasmapy/formulary) | +[docs](https://docs.plasmapy.org/en/latest/formulary/index.html)) +as our guide. - Day 4 & 5 (intermediate/advanced) - : The last two days will focus on developing functionality participants - are interested in, which can be suggested by any participant and/or - select from pre-outlined - [project issues](https://github.com/PlasmaPy/hack-week/issues?q=is%3Aissue+is%3Aopen+label%3A2022). +Day 4 & 5 (intermediate/advanced) +: The last two days will focus on developing functionality participants +are interested in, which can be suggested by any participant and/or +select from pre-outlined +[project issues](https://github.com/PlasmaPy/hack-week/issues?q=is%3Aissue+is%3Aopen+label%3A2022). Since this year's event is focused on hacking and learning by doing, it is in its nature free-form. So, feel free to bring up any topic you are @@ -58,7 +58,7 @@ discuss to explore your ideas. <iframe src="https://docs.google.com/spreadsheets/d/e/2PACX-1vRPRayajKEzzmfIi8B9hpvUQ3SJLWTXJ3ktr3XlW6CubXOgoOlQK66qYsTzMHxCG1wZW-iySIs_IkIM/pubhtml?gid=829020640&single=true&widget=true&headers=false"></iframe> --> -<iframe +<iframe name="2021HW_schedule" style="width: 100%; height: 700px; overflow: hidden; margin-bottom: 18px" src="https://docs.google.com/spreadsheets/d/e/2PACX-1vRPRayajKEzzmfIi8B9hpvUQ3SJLWTXJ3ktr3XlW6CubXOgoOlQK66qYsTzMHxCG1wZW-iySIs_IkIM/pubhtml?gid=829020640&single=true&widget=false&headers=false&chrome=false&range=A1:H32"> diff --git a/pages/index.md b/pages/index.md index 39bbf24..9bbbf4f 100644 --- a/pages/index.md +++ b/pages/index.md @@ -2,12 +2,13 @@ title: Plasma Hack Week hidetitle: True <!-- Feature Cards --> + <div class="feature-row" style="margin-bottom: 16px"> <!-- Feature 1 --> <div class="feature-column"> <a class="feature-link" href="https://discord.gg/HdsZkp9M35"> - <div class="feature-card" - style="background: linear-gradient(to left, + <div class="feature-card" + style="background: linear-gradient(to left, var(--plasmapy-darkblue) 0%, var(--plasmapy-light-red) 200%);"> <div> @@ -26,7 +27,7 @@ hidetitle: True <!-- Feature 2 --> <div class="feature-column"> <a class="feature-link" href="2022/about"> - <div class="feature-card" + <div class="feature-card" style="background-image: none; background-color: var(--plasmapy-darkblue)"> <div> @@ -41,8 +42,8 @@ hidetitle: True <!-- Feature 3 --> <div class="feature-column"> <a class="feature-link" href="2022/exit_survey"> - <div class="feature-card" - style="background: linear-gradient(to right, + <div class="feature-card" + style="background: linear-gradient(to right, var(--plasmapy-darkblue) 0%, var(--plasmapy-bluegreen) 200%);"> <div> @@ -65,20 +66,20 @@ released. The term hacking has a broad range of use in modern day slang. Hacking during the **Plasma Hack Week** event is seen as a collaborative -coding session among novices, experts, and like-minded learners to work -on projects and learn from each other. Hacking is a learn-by-doing +coding session among novices, experts, and like-minded learners to work +on projects and learn from each other. Hacking is a learn-by-doing activity, one of the best ways to further our knowledge. **A [hack week](https://doi.org/10.1073/pnas.1717196115) is a combination -of a hackathon (a marathon of hacking) and a summer school.** While +of a hackathon (a marathon of hacking) and a summer school.** While hackathons have traditionally prioritized collaborative code development -activities, a hack week includes a teaching component. Hack weeks +activities, a hack week includes a teaching component. Hack weeks typically have both structured learning activities (such as tutorials) as well as unstructured project time. A hack week is a chance to: - + - Learn how to contribute to an open source project; - Learn new software development skills with peers; -- Network with fellow plasma students and researchers who are engaging +- Network with fellow plasma students and researchers who are engaging in software development; - Meet fellow students and scientists who are engaging in programming; - Collaborate on adding a new feature to an existing software project; @@ -94,7 +95,7 @@ join the [Plasma Coders](https://discord.gg/HdsZkp9M35) group on Discord. ## Registration -For information about registering please check out our +For information about registering please check out our [2022 Hack Week registration page](./2022/registration). <!-- @@ -106,7 +107,7 @@ would like to install any of the software needed for the Hack Week. Alternatively, clicking on the following binder link will initialize a Python environment that can be run from your browser. This environment will have most of the Python packages needed for the week pre-installed, -along with `git`. +along with `git`. [](https://mybinder.org/v2/gh/PlasmaPy/hack-week/HEAD) --> @@ -114,7 +115,7 @@ along with `git`. ## Resources We have compiled [resources](./resources) that are likely to be useful -for Hack Week participants. Topics include Python, git/GitHub, and +for Hack Week participants. Topics include Python, git/GitHub, and research software engineering best practices. ## Code of conduct @@ -125,8 +126,8 @@ Conduct](https://www.contributor-covenant.org/version/2/0/code_of_conduct/). <!-- ## Python tutorials -We held two [tutorials to introduce Python](./2022/python) to -participants who are new to Python. These tutorials were held +We held two [tutorials to introduce Python](./2022/python) to +participants who are new to Python. These tutorials were 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). --> @@ -136,6 +137,6 @@ the week before the Hack Week on Monday, June 21 and Tuesday, June 22 at This website is made available under the [Creative Commons Attribution 4.0 International](https://creativecommons.org/licenses/by/4.0/) (CC BY 4.0) license. Portions of this website have been adapted from -[PlasmaPy's main website](https://www.plasmapy.org/) and the +[PlasmaPy's main website](https://www.plasmapy.org/) and the [HackWeek Toolkit](https://uwescience.github.io/HackWeek-Toolkit/#) under the terms of the CC BY 4.0 license. diff --git a/pages/resources.md b/pages/resources.md index addfb7d..608f24c 100644 --- a/pages/resources.md +++ b/pages/resources.md @@ -10,47 +10,47 @@ Python](https://merely-useful.tech/py-rse/). ## Version control - - [git and GitHub tutorial](https://www.youtube.com/watch?v=xuB1Id2Wxak) - - [GitHub Guides](https://guides.github.com/) +- [git and GitHub tutorial](https://www.youtube.com/watch?v=xuB1Id2Wxak) +- [GitHub Guides](https://guides.github.com/) ## [Python](https://www.python.org/) - - - [Official Python documentation](https://docs.python.org/3/) (including - a [Python tutorial](https://docs.python.org/3/tutorial/)) - - [PEP 8 style guide for Python](https://www.python.org/dev/peps/pep-0008/) - - [Python Tutorial for Beginners](https://www.youtube.com/watch?v=mJEpimi_tFo) - + +- [Official Python documentation](https://docs.python.org/3/) (including + a [Python tutorial](https://docs.python.org/3/tutorial/)) +- [PEP 8 style guide for Python](https://www.python.org/dev/peps/pep-0008/) +- [Python Tutorial for Beginners](https://www.youtube.com/watch?v=mJEpimi_tFo) + ### Testing Python software - - [pytest](https://docs.pytest.org/en/stable/) - - [Learn pytest in 60 minutes](https://www.youtube.com/watch?v=bbp_849-RZ4) - +- [pytest](https://docs.pytest.org/en/stable/) +- [Learn pytest in 60 minutes](https://www.youtube.com/watch?v=bbp_849-RZ4) + ### Writing Python documentation - - [Getting started with Sphinx](https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html) +- [Getting started with Sphinx](https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html) ## Best practices - - [Best practices for scientific computing](https://doi.org/10.1371/journal.pbio.1001745) and its prequel [Good enough practices in scientific computing](https://doi.org/10.1371/journal.pcbi.1005510) - - [Writing clean scientific software](https://doi.org/10.5281/zenodo.3922956) - - [Choose an open source license](https://choosealicense.com/) - - [How to cite software](https://libguides.mit.edu/c.php?g=551454&p=3900280) +- [Best practices for scientific computing](https://doi.org/10.1371/journal.pbio.1001745) and its prequel [Good enough practices in scientific computing](https://doi.org/10.1371/journal.pcbi.1005510) +- [Writing clean scientific software](https://doi.org/10.5281/zenodo.3922956) +- [Choose an open source license](https://choosealicense.com/) +- [How to cite software](https://libguides.mit.edu/c.php?g=551454&p=3900280) ### Scientific Python packages - - [NumPy](https://numpy.org/doc/) - - [SciPy](https://docs.scipy.org/doc/scipy/reference/) - - [matplotlib](https://matplotlib.org/stable/index.html) - - [pandas](https://pandas.pydata.org/) - - [xarray](http://xarray.pydata.org/en/stable/) - - [Astropy](https://docs.astropy.org/en/stable/) +- [NumPy](https://numpy.org/doc/) +- [SciPy](https://docs.scipy.org/doc/scipy/reference/) +- [matplotlib](https://matplotlib.org/stable/index.html) +- [pandas](https://pandas.pydata.org/) +- [xarray](http://xarray.pydata.org/en/stable/) +- [Astropy](https://docs.astropy.org/en/stable/) ## Plasma software - - [PlasmaPy](https://docs.plasmapy.org/en/latest) - - [OMFIT](https://omfit.io) - - [BOUT++](https://boutproject.github.io/) - - [GKEYLL](https://gkeyll.readthedocs.io/en/latest/) - - [SunPy](https://docs.sunpy.org) - - [TurboPy](https://turbopy.readthedocs.io/en/latest/) - - [OMAS](https://gafusion.github.io/omas/) +- [PlasmaPy](https://docs.plasmapy.org/en/latest) +- [OMFIT](https://omfit.io) +- [BOUT++](https://boutproject.github.io/) +- [GKEYLL](https://gkeyll.readthedocs.io/en/latest/) +- [SunPy](https://docs.sunpy.org) +- [TurboPy](https://turbopy.readthedocs.io/en/latest/) +- [OMAS](https://gafusion.github.io/omas/) From 6f9cbff2c1df02e49defbab838a69d75fd25c40d Mon Sep 17 00:00:00 2001 From: Nick Murphy <namurphy@cfa.harvard.edu> Date: Wed, 27 Mar 2024 14:19:17 -0400 Subject: [PATCH 05/13] Update conf.py --- conf.py | 90 +++++++++------------------------------------------------ 1 file changed, 13 insertions(+), 77 deletions(-) diff --git a/conf.py b/conf.py index cbb5d10..d28ed88 100644 --- a/conf.py +++ b/conf.py @@ -40,70 +40,6 @@ CODE_OF_CONDUCT = "https://www.contributor-covenant.org/version/2/0/code_of_conduct/" LICENSE = "https://creativecommons.org/licenses/by/4.0/" -# Nikola is multilingual! -# -# Currently supported languages are: -# -# en English -# af Afrikaans -# ar Arabic -# az Azerbaijani -# bg Bulgarian -# bs Bosnian -# ca Catalan -# cs Czech [ALTERNATIVELY cz] -# da Danish -# de German -# el Greek [NOT gr] -# eo Esperanto -# es Spanish -# et Estonian -# eu Basque -# fa Persian -# fi Finnish -# fr French -# fur Friulian -# gl Galician -# he Hebrew -# hi Hindi -# hr Croatian -# hu Hungarian -# ia Interlingua -# id Indonesian -# it Italian -# ja Japanese [NOT jp] -# ko Korean -# lt Lithuanian -# ml Malayalam -# nb Norwegian (Bokmål) -# nl Dutch -# pa Punjabi -# pl Polish -# pt Portuguese -# pt_br Portuguese (Brazil) -# ru Russian -# sk Slovak -# sl Slovene -# sq Albanian -# sr Serbian (Cyrillic) -# sr_latin Serbian (Latin) -# sv Swedish -# te Telugu -# th Thai -# tr Turkish [NOT tr_TR] -# uk Ukrainian -# ur Urdu -# vi Vietnamese -# zh_cn Chinese (Simplified) -# zh_tw Chinese (Traditional) -# -# If you want to use Nikola with a non-supported language you have to provide -# a module containing the necessary translations -# (cf. the modules at nikola/data/themes/base/messages/). -# If a specific post is not translated to a language, then the version -# in the default language will be shown instead. - -# What is the default language? DEFAULT_LANG = "en" # What other languages do you have? @@ -146,9 +82,9 @@ # may present issues if the menu is too large. # (in Bootstrap, the navbar can grow too large and cover contents.) # WARNING: If you link to directories, make sure to follow -# ``STRIP_INDEXES``. If it’s set to ``True``, end your links +# ``STRIP_INDEXES``. If it's set to ``True``, end your links # with a ``/``, otherwise end them with ``/index.html`` — or -# else they won’t be highlighted when active. +# else they won't be highlighted when active. NAVIGATION_LINKS = { DEFAULT_LANG: ( @@ -308,7 +244,7 @@ # # 0 = using DATE_FORMAT and TIMEZONE # 1 = using JS_DATE_FORMAT and local user time (via moment.js) -# 2 = using a string like “2 days ago” +# 2 = using a string like "2 days ago" # # Your theme must support it, Bootstrap already does. # DATE_FANCINESS = 0 @@ -421,7 +357,7 @@ # Set descriptions for tag pages to make them more interesting. The # default is no description. The value is used in the meta description -# and displayed underneath the tag list or index page’s title. +# and displayed underneath the tag list or index page's title. # TAG_DESCRIPTIONS = { # DEFAULT_LANG: { # "blogging": "Meta-blog posts about blogging.", @@ -494,7 +430,7 @@ # Set descriptions for category pages to make them more interesting. The # default is no description. The value is used in the meta description -# and displayed underneath the category list or index page’s title. +# and displayed underneath the category list or index page's title. # CATEGORY_DESCRIPTIONS = { # DEFAULT_LANG: { # "blogging": "Meta-blog posts about blogging.", @@ -573,7 +509,7 @@ # Set descriptions for author pages to make them more interesting. The # default is no description. The value is used in the meta description -# and displayed underneath the author list or index page’s title. +# and displayed underneath the author list or index page's title. # AUTHOR_PAGES_DESCRIPTIONS = { # DEFAULT_LANG: { # "Juanjo Conti": "Python coder and writer.", @@ -592,7 +528,7 @@ # (translatable) INDEX_PATH = "news/" -# Optional HTML that displayed on “main” blog index.html files. +# Optional HTML that displayed on "main" blog index.html files. # May be used for a greeting. (translatable) FRONT_INDEX_HEADER = { DEFAULT_LANG: '' @@ -727,7 +663,7 @@ # argument. # # By default, only .php files uses filters to inject PHP into -# Nikola’s templates. All other filters must be enabled through FILTERS. +# Nikola's templates. All other filters must be enabled through FILTERS. # # Many filters are shipped with Nikola. A list is available in the manual: # <https://getnikola.com/handbook.html#post-processing-filters> @@ -851,8 +787,8 @@ # # .. image:: /images/tesla.jpg # -# See the Nikola Handbook for details (in the “Embedding Images” and -# “Thumbnails” sections) +# See the Nikola Handbook for details (in the "Embedding Images" and +# "Thumbnails" sections) # Images will be scaled down according to IMAGE_THUMBNAIL_SIZE and MAX_IMAGE_SIZE # options, but will have to be referenced manually to be visible on the site @@ -944,10 +880,10 @@ # HTML fragments with the Read more... links. # The following tags exist and are replaced for you: # {link} A link to the full post page. -# {read_more} The string “Read more” in the current language. +# {read_more} The string "Read more" in the current language. # {reading_time} An estimate of how long it will take to read the post. # {remaining_reading_time} An estimate of how long it will take to read the post, sans the teaser. -# {min_remaining_read} The string “{remaining_reading_time} min remaining to read” in the current language. +# {min_remaining_read} The string "{remaining_reading_time} min remaining to read" in the current language. # {paragraph_count} The amount of paragraphs in the post. # {remaining_paragraph_count} The amount of paragraphs in the post, sans the teaser. # {post_title} The title of the post. @@ -1397,7 +1333,7 @@ # (defaults to 1.) # DEMOTE_HEADERS = 1 -# If you don’t like slugified file names ([a-z0-9] and a literal dash), +# If you don't like slugified file names ([a-z0-9] and a literal dash), # and would prefer to use all the characters your file system allows. # USE WITH CARE! This is also not guaranteed to be perfect, and may # sometimes crash Nikola, your web server, or eat your cat. From 9259abad4f0ebba00e914c5f26911a9a0244dd6a Mon Sep 17 00:00:00 2001 From: Nick Murphy <namurphy@cfa.harvard.edu> Date: Wed, 27 Mar 2024 14:19:53 -0400 Subject: [PATCH 06/13] Apply pre-commit updates --- CODE_OF_CONDUCT.rst | 4 ++-- LICENSE.md | 6 +++--- files/assets/css/custom.css | 2 +- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/CODE_OF_CONDUCT.rst b/CODE_OF_CONDUCT.rst index d34fb59..acaa289 100644 --- a/CODE_OF_CONDUCT.rst +++ b/CODE_OF_CONDUCT.rst @@ -104,14 +104,14 @@ member of the Coordinating Committee. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. -Project team members should recuse themselves from enforcement of the +Project team members should recurse themselves from enforcement of the code of conduct for a given incident if they have an actual or apparent conflict of interest. Further details of specific enforcement policies may be posted separately. Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined -by other members of the project’s leadership. +by other members of the project's leadership. Attribution ----------- diff --git a/LICENSE.md b/LICENSE.md index 3e9d1f0..90e2d69 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -16,14 +16,14 @@ Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: -* Redistributions of source code must retain the above copyright +- Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. -* Redistributions in binary form must reproduce the above copyright +- Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. -* Neither the name of PlasmaPy nor the names of its contributors may +- Neither the name of PlasmaPy nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. diff --git a/files/assets/css/custom.css b/files/assets/css/custom.css index a3aa644..853f7e3 100644 --- a/files/assets/css/custom.css +++ b/files/assets/css/custom.css @@ -158,7 +158,7 @@ table tr th :last-child, table tr td :last-child { border-color: #017BFF } -/* Center (vertical & horizontal) div withing feature-card */ +/* Center (vertical & horizontal) div within feature-card */ .feature-card div { position: absolute; width: 100%; From 27acc88c6779ab702ed0aae2bb33008899328e0f Mon Sep 17 00:00:00 2001 From: Nick Murphy <namurphy@cfa.harvard.edu> Date: Wed, 27 Mar 2024 14:20:07 -0400 Subject: [PATCH 07/13] Update quotes --- .github/workflows/deploy.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index 5b87e01..f568606 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -14,7 +14,7 @@ jobs: env: DRY_RUN: ${{ github.event_name == 'pull_request' }} - DEPLOY: "" + DEPLOY: '' steps: - name: Checkout code From 0652d1ab23e0e85fca1ebaa32e7b8db9374f0d36 Mon Sep 17 00:00:00 2001 From: Nick Murphy <namurphy@cfa.harvard.edu> Date: Wed, 27 Mar 2024 14:21:34 -0400 Subject: [PATCH 08/13] Fix trailing whitespace --- .../localsearch/files/assets/js/tipuesearch.js | 14 +++++++------- plugins/localsearch/search-EXAMPLE.html | 8 ++++---- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/plugins/localsearch/localsearch/files/assets/js/tipuesearch.js b/plugins/localsearch/localsearch/files/assets/js/tipuesearch.js index 4824566..156e51a 100644 --- a/plugins/localsearch/localsearch/files/assets/js/tipuesearch.js +++ b/plugins/localsearch/localsearch/files/assets/js/tipuesearch.js @@ -594,18 +594,18 @@ http://www.tipue.com/search $('.tipue_search_image_close').click(function() { $('#tipue_search_image_modal').fadeOut(300); - }); - + }); + $('.tipue_search_foot_box').click(function() { var id_v = $(this).attr('id'); var id_a = id_v.split('_'); - + getTipueSearch(parseInt(id_a[0]), id_a[1]); - }); - } - + }); + } + }); }; - + })(jQuery); diff --git a/plugins/localsearch/search-EXAMPLE.html b/plugins/localsearch/search-EXAMPLE.html index f8970bc..c0cceee 100644 --- a/plugins/localsearch/search-EXAMPLE.html +++ b/plugins/localsearch/search-EXAMPLE.html @@ -2,10 +2,10 @@ .. title: Search .. slug: search .. date: 1970-01-01 00:00:00Z -.. tags: -.. category: -.. link: -.. description: +.. tags: +.. category: +.. link: +.. description: .. type: text .. template: localsearch.tmpl --> From fc7248f344d0881ed0ccb1b097cab2e5cd9fb988 Mon Sep 17 00:00:00 2001 From: Nick Murphy <namurphy@cfa.harvard.edu> Date: Wed, 27 Mar 2024 14:22:11 -0400 Subject: [PATCH 09/13] end-of-file-fixer --- .../localsearch/localsearch/files/assets/css/tipuesearch.css | 1 - .../localsearch/localsearch/files/assets/js/tipuesearch.min.js | 2 +- .../localsearch/localsearch/files/assets/js/tipuesearch_set.js | 1 - 3 files changed, 1 insertion(+), 3 deletions(-) diff --git a/plugins/localsearch/localsearch/files/assets/css/tipuesearch.css b/plugins/localsearch/localsearch/files/assets/css/tipuesearch.css index 5793c6d..4ae2400 100644 --- a/plugins/localsearch/localsearch/files/assets/css/tipuesearch.css +++ b/plugins/localsearch/localsearch/files/assets/css/tipuesearch.css @@ -268,4 +268,3 @@ http://www.tipue.com/search background: #252525; color: #ccc; } - diff --git a/plugins/localsearch/localsearch/files/assets/js/tipuesearch.min.js b/plugins/localsearch/localsearch/files/assets/js/tipuesearch.min.js index f50ef6e..555524a 100644 --- a/plugins/localsearch/localsearch/files/assets/js/tipuesearch.min.js +++ b/plugins/localsearch/localsearch/files/assets/js/tipuesearch.min.js @@ -178,4 +178,4 @@ $('#tipue_search_content').hide().html(out).slideDown(200);$('#tipue_search_repl {$('#tipue_search_input').val($(this).attr('id'));getTipueSearch(0,true);});$('.tipue_search_image_zoom').click(function() {$('#tipue_search_image_modal').fadeIn(300);$('#tipue_search_zoom_img').attr('src',this.src);var z_u=$(this).attr('data-url');$('#tipue_search_zoom_url').attr('href',z_u);var z_o=this.alt+'<div class="tipue_search_zoom_options"><a href="'+this.src+'" target="_blank">'+tipuesearch_string_15+'</a> <a href="'+z_u+'">'+tipuesearch_string_16+'</a></div>';$('#tipue_search_zoom_text').html(z_o);});$('.tipue_search_image_close').click(function() {$('#tipue_search_image_modal').fadeOut(300);});$('.tipue_search_foot_box').click(function() -{var id_v=$(this).attr('id');var id_a=id_v.split('_');getTipueSearch(parseInt(id_a[0]),id_a[1]);});}});};})(jQuery); \ No newline at end of file +{var id_v=$(this).attr('id');var id_a=id_v.split('_');getTipueSearch(parseInt(id_a[0]),id_a[1]);});}});};})(jQuery); diff --git a/plugins/localsearch/localsearch/files/assets/js/tipuesearch_set.js b/plugins/localsearch/localsearch/files/assets/js/tipuesearch_set.js index 8475b5c..6b8e4cf 100644 --- a/plugins/localsearch/localsearch/files/assets/js/tipuesearch_set.js +++ b/plugins/localsearch/localsearch/files/assets/js/tipuesearch_set.js @@ -81,4 +81,3 @@ var tipuesearch_string_16 = 'Goto Page'; // Timer for showTime var startTimer = new Date().getTime(); - From cd9eba854e563d5315663be688ad0f735aef2b8b Mon Sep 17 00:00:00 2001 From: Nick Murphy <namurphy@cfa.harvard.edu> Date: Wed, 27 Mar 2024 14:22:55 -0400 Subject: [PATCH 10/13] Exclude some files --- .pre-commit-config.yaml | 1 + 1 file changed, 1 insertion(+) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index d670070..6aa3565 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -56,6 +56,7 @@ repos: args: [--write-changes] additional_dependencies: - tomli + exclude: shortcodes|plugins - repo: https://github.com/executablebooks/mdformat rev: 0.7.17 From ab2688a7a693be51083130d7243709fbdc7c8cb5 Mon Sep 17 00:00:00 2001 From: Nick Murphy <namurphy@cfa.harvard.edu> Date: Wed, 27 Mar 2024 14:23:34 -0400 Subject: [PATCH 11/13] Apply mdformat --- plugins/localsearch/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/plugins/localsearch/README.md b/plugins/localsearch/README.md index f7321da..ac4c977 100644 --- a/plugins/localsearch/README.md +++ b/plugins/localsearch/README.md @@ -4,10 +4,10 @@ search will be performed client side. It uses [Tipue Search](http://www.tipue.co In ordrer to set up Tipue, you will need: - * the sample config from `conf.py.sample` and a page set up to render `localsearch.tmpl` (which you may customize) — - an example is in `search-EXAMPLE.html` - * or the alternate sample config from `conf.py.sample.alt`, which uses a modal - and does not need another page +- the sample config from `conf.py.sample` and a page set up to render `localsearch.tmpl` (which you may customize) — + an example is in `search-EXAMPLE.html` +- or the alternate sample config from `conf.py.sample.alt`, which uses a modal + and does not need another page For more information about how to customize it and use it, please refer to the Tipue docs at http://www.tipue.com/search/ From 29d912f3f96843a8c73ee69bfece9cbff278e0fa Mon Sep 17 00:00:00 2001 From: Nick Murphy <namurphy@cfa.harvard.edu> Date: Wed, 27 Mar 2024 14:25:27 -0400 Subject: [PATCH 12/13] Remove unnecessary default language version --- .pre-commit-config.yaml | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 6aa3565..3dacda8 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -2,10 +2,6 @@ ci: autofix_prs: false autoupdate_schedule: monthly -# Specify the default version of Ruby in case it is not installed -default_language_version: - ruby: 2.7.2 - repos: - repo: https://github.com/pre-commit/pre-commit-hooks @@ -28,7 +24,7 @@ repos: - id: check-github-workflows - repo: https://github.com/sirosen/texthooks - rev: 0.6.4 + rev: 0.6.6 hooks: - id: fix-smartquotes - id: fix-spaces From 4f77f954627f510ee8052383d4da60eb1d017c65 Mon Sep 17 00:00:00 2001 From: Nick Murphy <namurphy@cfa.harvard.edu> Date: Wed, 27 Mar 2024 14:26:59 -0400 Subject: [PATCH 13/13] Exclude code of conduct from codespell --- .pre-commit-config.yaml | 2 +- CODE_OF_CONDUCT.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 3dacda8..1821b1f 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -52,7 +52,7 @@ repos: args: [--write-changes] additional_dependencies: - tomli - exclude: shortcodes|plugins + exclude: shortcodes|plugins|CODE_OF_CONDUCT.rst - repo: https://github.com/executablebooks/mdformat rev: 0.7.17 diff --git a/CODE_OF_CONDUCT.rst b/CODE_OF_CONDUCT.rst index acaa289..c55fb86 100644 --- a/CODE_OF_CONDUCT.rst +++ b/CODE_OF_CONDUCT.rst @@ -104,7 +104,7 @@ member of the Coordinating Committee. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. -Project team members should recurse themselves from enforcement of the +Project team members should recuse themselves from enforcement of the code of conduct for a given incident if they have an actual or apparent conflict of interest. Further details of specific enforcement policies may be posted separately.