From 4a95c0c6cc0d0532d1220e5510622a7e065cd997 Mon Sep 17 00:00:00 2001
From: Julieanna Bacon <julieannabacon2014@gmail.com>
Date: Thu, 15 Feb 2024 11:31:53 -0500
Subject: [PATCH] Deployed 58ddf3d with MkDocs version: 1.5.3

---
 index.html               |    2 +-
 search/search_index.json |    2 +-
 setup.html               | 1125 ++++++++++++++++++++++++++++++++++++++
 setup/index.html         |    4 +-
 sitemap.xml.gz           |  Bin 127 -> 127 bytes
 5 files changed, 1130 insertions(+), 3 deletions(-)
 create mode 100644 setup.html

diff --git a/index.html b/index.html
index 649af53..216ec4b 100644
--- a/index.html
+++ b/index.html
@@ -215,5 +215,5 @@ <h4 class="modal-title" id="keyboardModalLabel">Keyboard Shortcuts</h4>
 
 <!--
 MkDocs version : 1.5.3
-Build Date UTC : 2024-02-15 16:25:05.486013+00:00
+Build Date UTC : 2024-02-15 16:31:53.530572+00:00
 -->
diff --git a/search/search_index.json b/search/search_index.json
index 9b20730..1d82fad 100644
--- a/search/search_index.json
+++ b/search/search_index.json
@@ -1 +1 @@
-{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"IceDyno Documentation \u00b6 Short-Term Forecasting of Sea-Ice Edge Boundaries in the Arctic \u00b6 Authors: Ruchi Asthana, Julieanna Bacon, Brendon Gory, Matthew Thanos, Soolu Thomas Welcome to the project! This is a data science Master's capstone through Harvard University's Extension School, in collaboration with NOAA. Documentation \u00b6 Mkdocs is the documentation engine that takes hand-written markdown files to a project website. Please read more at https://www.mkdocs.org/. Mkdocstrings is a mkdocs extension that allows autogenerated documentation to be made, by scraping type hints and documentation strings for any python modules within the project. Building and serving the documentation commands \u00b6 mkdocs new [dir-name] - Create a new project. mkdocs serve - Start the live-reloading docs server. mkdocs build - Build the documentation site. mkdocs -h - Print help message and exit. Documentation files layout \u00b6 mkdocs.yml # The configuration file. docs/ index.md # The documentation homepage. ... # Other markdown pages, images and other files. Add a new page or subpage \u00b6 To add a new page, in mkdocs.yml add the page (or subpage) by: site_name: IceDyno Documentation nav: - Home: index.md - Setup: setup.md - New Page: newpage.md - New SubPage: newsubpage.md - ... Autogenerate documentation for an IceDyno module \u00b6 Add to a markdown file something like this: ::: icedyno.preprocess","title":"Home"},{"location":"#icedyno-documentation","text":"","title":"IceDyno Documentation"},{"location":"#short-term-forecasting-of-sea-ice-edge-boundaries-in-the-arctic","text":"Authors: Ruchi Asthana, Julieanna Bacon, Brendon Gory, Matthew Thanos, Soolu Thomas Welcome to the project! This is a data science Master's capstone through Harvard University's Extension School, in collaboration with NOAA.","title":"Short-Term Forecasting of Sea-Ice Edge Boundaries in the Arctic"},{"location":"#documentation","text":"Mkdocs is the documentation engine that takes hand-written markdown files to a project website. Please read more at https://www.mkdocs.org/. Mkdocstrings is a mkdocs extension that allows autogenerated documentation to be made, by scraping type hints and documentation strings for any python modules within the project.","title":"Documentation"},{"location":"#building-and-serving-the-documentation-commands","text":"mkdocs new [dir-name] - Create a new project. mkdocs serve - Start the live-reloading docs server. mkdocs build - Build the documentation site. mkdocs -h - Print help message and exit.","title":"Building and serving the documentation commands"},{"location":"#documentation-files-layout","text":"mkdocs.yml # The configuration file. docs/ index.md # The documentation homepage. ... # Other markdown pages, images and other files.","title":"Documentation files layout"},{"location":"#add-a-new-page-or-subpage","text":"To add a new page, in mkdocs.yml add the page (or subpage) by: site_name: IceDyno Documentation nav: - Home: index.md - Setup: setup.md - New Page: newpage.md - New SubPage: newsubpage.md - ...","title":"Add a new page or subpage"},{"location":"#autogenerate-documentation-for-an-icedyno-module","text":"Add to a markdown file something like this: ::: icedyno.preprocess","title":"Autogenerate documentation for an IceDyno module"},{"location":"GH-cheatsheet/","text":"GitHub Cheatsheet \u00b6 Here's a quick cheatsheet on getting started with a GitHub project, if you are new to GitHub. Before we start, anything that is within the angle brackets ( < or > ) should be replaced as a whole. For example: <your-username> should be replaced to something like SooluThomas Table of contents \u00b6 Set up SSH keys Clone repository Create feature branches Check username and email in your local git Add, commit and push changes to feature branch Create Pull Request Pull changes from the main to feature branch Set up SSH keys \u00b6 Most of GitHub's documentation is pretty good. So pointing to GH docs for 1. Check for existing SSH key 2. Generate new SSH key > Its easier to just follow the 3 steps mentioned under \"Generating a new SSH key\" section. 3. Add a new SSH key 4. Test your SSH connection Clone repository \u00b6 Once SSH keys are set up, in your terminal move to the which ever directory you want to have the local repo copy to live using the command cd Documents/<your-folder-path>/Capstone Then clone the repo using the command git clone git@github.com:NOAA-HES-Capstone/icedyno.git cd icedyno (Tip: the link was obtained from the repo -> green button called \"Code\" on top right of the repo -> SSH) Once this is done, you should be able to see the main branch (by default) locally. Create feature branches \u00b6 Create a branch using the command git checkout -b <your-initials>/<branch-name> # This command can show you which branch you are in # The * shows the current branch you are in git branch # you can use `git checkout main` to go to main branch and then # `git checkout <branch-name>` to go to different branch Check username and email in your local git \u00b6 This is an optional step but might be nice to have. This is a one-time thing to do. Run the following: git config user.name git config user.email If this is showing the correct github username and email, you are good. Otherwise, run git config user.name <your-username> git config user.email <your-registered-email> Add, commit and push changes to feature branch \u00b6 # This will show us a summary of the files changed when compared main branch git status # Add the files that were changed # It is always best to add the file names rather than to use `git add *` # so that unwanted files don't get added git add <path>/<file-name> # Commit your changes git commit -m \"Type out commit message with a one line summary briefing the changes\" # TIP: if you want to add more descriptive commit add -m \"descriptive message\" # after the one line summary message # [ALWAYS] Push commit to your branch git push origin <your-initials>/<branch-name> Create Pull Request \u00b6 If you are pushing from a branch for the first time , the first commit will show a link that point to creating a pull request (PR) directly. It should be something like Enumerating objects: 4, done. Counting objects: 100% (4/4), done. Delta compression using up to 12 threads Compressing objects: 100% (3/3), done. Writing objects: 100% (3/3), 1.36 KiB | 1.36 MiB/s, done. Total 3 (delta 0), reused 0 (delta 0), pack-reused 0 remote: remote: Create a pull request for 'soo/add-gh-cheatsheat' on GitHub by visiting remote: https://github.com/NOAA-HES-Capstone/icedyno/pull/new/soo/add-gh-cheatsheat remote: To github.com:NOAA-HES-Capstone/icedyno.git * [new branch] soo/add-gh-cheatsheat -> soo/add-gh-cheatsheat Another way to open a PR is going to the repo itself and find your branch name under the branch selector in the repository. After you click on it, it should have a button to create a pull request. Pull changes from the main to feature branch \u00b6 There could be cases where other PRs could be merged before ours and so we will need to pull those changes in our branch before we can merge or to make sure that our work doesn't break anything with the new changes made in the main branch. For this we can use # Fetch all the changes from remote to local git fetch # pull the changes from main to our feature branch git pull origin main If your are pulling for the first time in that repo, the might be a lot more that will be asked in the terminal and run the command for merge which is something like git config pull.rebase false Let's keep this file growing with the GitHub tips that you get know and would like to share with others.","title":"GitHub"},{"location":"GH-cheatsheet/#github-cheatsheet","text":"Here's a quick cheatsheet on getting started with a GitHub project, if you are new to GitHub. Before we start, anything that is within the angle brackets ( < or > ) should be replaced as a whole. For example: <your-username> should be replaced to something like SooluThomas","title":"GitHub Cheatsheet"},{"location":"GH-cheatsheet/#table-of-contents","text":"Set up SSH keys Clone repository Create feature branches Check username and email in your local git Add, commit and push changes to feature branch Create Pull Request Pull changes from the main to feature branch","title":"Table of contents"},{"location":"GH-cheatsheet/#set-up-ssh-keys","text":"Most of GitHub's documentation is pretty good. So pointing to GH docs for 1. Check for existing SSH key 2. Generate new SSH key > Its easier to just follow the 3 steps mentioned under \"Generating a new SSH key\" section. 3. Add a new SSH key 4. Test your SSH connection","title":"Set up SSH keys"},{"location":"GH-cheatsheet/#clone-repository","text":"Once SSH keys are set up, in your terminal move to the which ever directory you want to have the local repo copy to live using the command cd Documents/<your-folder-path>/Capstone Then clone the repo using the command git clone git@github.com:NOAA-HES-Capstone/icedyno.git cd icedyno (Tip: the link was obtained from the repo -> green button called \"Code\" on top right of the repo -> SSH) Once this is done, you should be able to see the main branch (by default) locally.","title":"Clone repository"},{"location":"GH-cheatsheet/#create-feature-branches","text":"Create a branch using the command git checkout -b <your-initials>/<branch-name> # This command can show you which branch you are in # The * shows the current branch you are in git branch # you can use `git checkout main` to go to main branch and then # `git checkout <branch-name>` to go to different branch","title":"Create feature branches"},{"location":"GH-cheatsheet/#check-username-and-email-in-your-local-git","text":"This is an optional step but might be nice to have. This is a one-time thing to do. Run the following: git config user.name git config user.email If this is showing the correct github username and email, you are good. Otherwise, run git config user.name <your-username> git config user.email <your-registered-email>","title":"Check username and email in your local git"},{"location":"GH-cheatsheet/#add-commit-and-push-changes-to-feature-branch","text":"# This will show us a summary of the files changed when compared main branch git status # Add the files that were changed # It is always best to add the file names rather than to use `git add *` # so that unwanted files don't get added git add <path>/<file-name> # Commit your changes git commit -m \"Type out commit message with a one line summary briefing the changes\" # TIP: if you want to add more descriptive commit add -m \"descriptive message\" # after the one line summary message # [ALWAYS] Push commit to your branch git push origin <your-initials>/<branch-name>","title":"Add, commit and push changes to feature branch"},{"location":"GH-cheatsheet/#create-pull-request","text":"If you are pushing from a branch for the first time , the first commit will show a link that point to creating a pull request (PR) directly. It should be something like Enumerating objects: 4, done. Counting objects: 100% (4/4), done. Delta compression using up to 12 threads Compressing objects: 100% (3/3), done. Writing objects: 100% (3/3), 1.36 KiB | 1.36 MiB/s, done. Total 3 (delta 0), reused 0 (delta 0), pack-reused 0 remote: remote: Create a pull request for 'soo/add-gh-cheatsheat' on GitHub by visiting remote: https://github.com/NOAA-HES-Capstone/icedyno/pull/new/soo/add-gh-cheatsheat remote: To github.com:NOAA-HES-Capstone/icedyno.git * [new branch] soo/add-gh-cheatsheat -> soo/add-gh-cheatsheat Another way to open a PR is going to the repo itself and find your branch name under the branch selector in the repository. After you click on it, it should have a button to create a pull request.","title":"Create Pull Request"},{"location":"GH-cheatsheet/#pull-changes-from-the-main-to-feature-branch","text":"There could be cases where other PRs could be merged before ours and so we will need to pull those changes in our branch before we can merge or to make sure that our work doesn't break anything with the new changes made in the main branch. For this we can use # Fetch all the changes from remote to local git fetch # pull the changes from main to our feature branch git pull origin main If your are pulling for the first time in that repo, the might be a lot more that will be asked in the terminal and run the command for merge which is something like git config pull.rebase false Let's keep this file growing with the GitHub tips that you get know and would like to share with others.","title":"Pull changes from the main to feature branch"},{"location":"setup/","text":"Setup \u00b6 To get started, clone the repo, checkout this branch, using Linux or Mac install pixi with: curl -fsSL https://pixi.sh/install.sh | bash If using windows, install pixi with: iwr -useb https://pixi.sh/install.ps1 | iex See here for more info on pixi: https://pixi.sh/. Then to install the project and its dependencies, type: pixi install You could activate the virtual environment with pixi shell (so every command uses the virtual environment until you type exit ) or prefix your commands with pixi run inside the icedyno project folder (ex: pixi run pytest ). To set up the automatic linters (that run every time you commit your work), you would run: pixi run pre-commit install Testing the set up \u00b6 If you activated the pixi environment, type pytest . If not, type pixi run pytest . You should have one dummy test that runs on that command. What does it look like when the linters and pre-commit hooks run? \u00b6 After you've installed the pre-commit hooks and have changes to commit, this is what the process will look like for committing: You have changes to commit: Commit with a descriptive message: One-time setup of the linters: Our code was not already compliant with the linters, so they \"failed\" our commit and automatically changed things about our code to become compliant: Go ahead and inspect what got modified if you'd like: Add the changes and redo your commit command: Adding new dependencies \u00b6 Just write pixi add conda_or_pip_package_name . You can add multiple dependencies at once (which is better than one at a time, pixi will have to recompute work otherwise) by adding a space between the package names. I.e. pixi add package1 package2 package3 . You'll see that the pixi.toml and pixi.lock files will change after adding your new dependencies -- make sure to add those changes in your next commit! Removing a dependency \u00b6 pixi remove package_name","title":"Setup"},{"location":"setup/#setup","text":"To get started, clone the repo, checkout this branch, using Linux or Mac install pixi with: curl -fsSL https://pixi.sh/install.sh | bash If using windows, install pixi with: iwr -useb https://pixi.sh/install.ps1 | iex See here for more info on pixi: https://pixi.sh/. Then to install the project and its dependencies, type: pixi install You could activate the virtual environment with pixi shell (so every command uses the virtual environment until you type exit ) or prefix your commands with pixi run inside the icedyno project folder (ex: pixi run pytest ). To set up the automatic linters (that run every time you commit your work), you would run: pixi run pre-commit install","title":"Setup"},{"location":"setup/#testing-the-set-up","text":"If you activated the pixi environment, type pytest . If not, type pixi run pytest . You should have one dummy test that runs on that command.","title":"Testing the set up"},{"location":"setup/#what-does-it-look-like-when-the-linters-and-pre-commit-hooks-run","text":"After you've installed the pre-commit hooks and have changes to commit, this is what the process will look like for committing: You have changes to commit: Commit with a descriptive message: One-time setup of the linters: Our code was not already compliant with the linters, so they \"failed\" our commit and automatically changed things about our code to become compliant: Go ahead and inspect what got modified if you'd like: Add the changes and redo your commit command:","title":"What does it look like when the linters and pre-commit hooks run?"},{"location":"setup/#adding-new-dependencies","text":"Just write pixi add conda_or_pip_package_name . You can add multiple dependencies at once (which is better than one at a time, pixi will have to recompute work otherwise) by adding a space between the package names. I.e. pixi add package1 package2 package3 . You'll see that the pixi.toml and pixi.lock files will change after adding your new dependencies -- make sure to add those changes in your next commit!","title":"Adding new dependencies"},{"location":"setup/#removing-a-dependency","text":"pixi remove package_name","title":"Removing a dependency"},{"location":"workflow/","text":"IceDyno Dev Workflow \u00b6 This is where we should document how we should merge/rebase/squash/etc and things we should know while working.","title":"Workflow"},{"location":"workflow/#icedyno-dev-workflow","text":"This is where we should document how we should merge/rebase/squash/etc and things we should know while working.","title":"IceDyno Dev Workflow"}]}
\ No newline at end of file
+{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"IceDyno Documentation \u00b6 Short-Term Forecasting of Sea-Ice Edge Boundaries in the Arctic \u00b6 Authors: Ruchi Asthana, Julieanna Bacon, Brendon Gory, Matthew Thanos, Soolu Thomas Welcome to the project! This is a data science Master's capstone through Harvard University's Extension School, in collaboration with NOAA. Documentation \u00b6 Mkdocs is the documentation engine that takes hand-written markdown files to a project website. Please read more at https://www.mkdocs.org/. Mkdocstrings is a mkdocs extension that allows autogenerated documentation to be made, by scraping type hints and documentation strings for any python modules within the project. Building and serving the documentation commands \u00b6 mkdocs new [dir-name] - Create a new project. mkdocs serve - Start the live-reloading docs server. mkdocs build - Build the documentation site. mkdocs -h - Print help message and exit. Documentation files layout \u00b6 mkdocs.yml # The configuration file. docs/ index.md # The documentation homepage. ... # Other markdown pages, images and other files. Add a new page or subpage \u00b6 To add a new page, in mkdocs.yml add the page (or subpage) by: site_name: IceDyno Documentation nav: - Home: index.md - Setup: setup.md - New Page: newpage.md - New SubPage: newsubpage.md - ... Autogenerate documentation for an IceDyno module \u00b6 Add to a markdown file something like this: ::: icedyno.preprocess","title":"Home"},{"location":"#icedyno-documentation","text":"","title":"IceDyno Documentation"},{"location":"#short-term-forecasting-of-sea-ice-edge-boundaries-in-the-arctic","text":"Authors: Ruchi Asthana, Julieanna Bacon, Brendon Gory, Matthew Thanos, Soolu Thomas Welcome to the project! This is a data science Master's capstone through Harvard University's Extension School, in collaboration with NOAA.","title":"Short-Term Forecasting of Sea-Ice Edge Boundaries in the Arctic"},{"location":"#documentation","text":"Mkdocs is the documentation engine that takes hand-written markdown files to a project website. Please read more at https://www.mkdocs.org/. Mkdocstrings is a mkdocs extension that allows autogenerated documentation to be made, by scraping type hints and documentation strings for any python modules within the project.","title":"Documentation"},{"location":"#building-and-serving-the-documentation-commands","text":"mkdocs new [dir-name] - Create a new project. mkdocs serve - Start the live-reloading docs server. mkdocs build - Build the documentation site. mkdocs -h - Print help message and exit.","title":"Building and serving the documentation commands"},{"location":"#documentation-files-layout","text":"mkdocs.yml # The configuration file. docs/ index.md # The documentation homepage. ... # Other markdown pages, images and other files.","title":"Documentation files layout"},{"location":"#add-a-new-page-or-subpage","text":"To add a new page, in mkdocs.yml add the page (or subpage) by: site_name: IceDyno Documentation nav: - Home: index.md - Setup: setup.md - New Page: newpage.md - New SubPage: newsubpage.md - ...","title":"Add a new page or subpage"},{"location":"#autogenerate-documentation-for-an-icedyno-module","text":"Add to a markdown file something like this: ::: icedyno.preprocess","title":"Autogenerate documentation for an IceDyno module"},{"location":"GH-cheatsheet/","text":"GitHub Cheatsheet \u00b6 Here's a quick cheatsheet on getting started with a GitHub project, if you are new to GitHub. Before we start, anything that is within the angle brackets ( < or > ) should be replaced as a whole. For example: <your-username> should be replaced to something like SooluThomas Table of contents \u00b6 Set up SSH keys Clone repository Create feature branches Check username and email in your local git Add, commit and push changes to feature branch Create Pull Request Pull changes from the main to feature branch Set up SSH keys \u00b6 Most of GitHub's documentation is pretty good. So pointing to GH docs for 1. Check for existing SSH key 2. Generate new SSH key > Its easier to just follow the 3 steps mentioned under \"Generating a new SSH key\" section. 3. Add a new SSH key 4. Test your SSH connection Clone repository \u00b6 Once SSH keys are set up, in your terminal move to the which ever directory you want to have the local repo copy to live using the command cd Documents/<your-folder-path>/Capstone Then clone the repo using the command git clone git@github.com:NOAA-HES-Capstone/icedyno.git cd icedyno (Tip: the link was obtained from the repo -> green button called \"Code\" on top right of the repo -> SSH) Once this is done, you should be able to see the main branch (by default) locally. Create feature branches \u00b6 Create a branch using the command git checkout -b <your-initials>/<branch-name> # This command can show you which branch you are in # The * shows the current branch you are in git branch # you can use `git checkout main` to go to main branch and then # `git checkout <branch-name>` to go to different branch Check username and email in your local git \u00b6 This is an optional step but might be nice to have. This is a one-time thing to do. Run the following: git config user.name git config user.email If this is showing the correct github username and email, you are good. Otherwise, run git config user.name <your-username> git config user.email <your-registered-email> Add, commit and push changes to feature branch \u00b6 # This will show us a summary of the files changed when compared main branch git status # Add the files that were changed # It is always best to add the file names rather than to use `git add *` # so that unwanted files don't get added git add <path>/<file-name> # Commit your changes git commit -m \"Type out commit message with a one line summary briefing the changes\" # TIP: if you want to add more descriptive commit add -m \"descriptive message\" # after the one line summary message # [ALWAYS] Push commit to your branch git push origin <your-initials>/<branch-name> Create Pull Request \u00b6 If you are pushing from a branch for the first time , the first commit will show a link that point to creating a pull request (PR) directly. It should be something like Enumerating objects: 4, done. Counting objects: 100% (4/4), done. Delta compression using up to 12 threads Compressing objects: 100% (3/3), done. Writing objects: 100% (3/3), 1.36 KiB | 1.36 MiB/s, done. Total 3 (delta 0), reused 0 (delta 0), pack-reused 0 remote: remote: Create a pull request for 'soo/add-gh-cheatsheat' on GitHub by visiting remote: https://github.com/NOAA-HES-Capstone/icedyno/pull/new/soo/add-gh-cheatsheat remote: To github.com:NOAA-HES-Capstone/icedyno.git * [new branch] soo/add-gh-cheatsheat -> soo/add-gh-cheatsheat Another way to open a PR is going to the repo itself and find your branch name under the branch selector in the repository. After you click on it, it should have a button to create a pull request. Pull changes from the main to feature branch \u00b6 There could be cases where other PRs could be merged before ours and so we will need to pull those changes in our branch before we can merge or to make sure that our work doesn't break anything with the new changes made in the main branch. For this we can use # Fetch all the changes from remote to local git fetch # pull the changes from main to our feature branch git pull origin main If your are pulling for the first time in that repo, the might be a lot more that will be asked in the terminal and run the command for merge which is something like git config pull.rebase false Let's keep this file growing with the GitHub tips that you get know and would like to share with others.","title":"GitHub"},{"location":"GH-cheatsheet/#github-cheatsheet","text":"Here's a quick cheatsheet on getting started with a GitHub project, if you are new to GitHub. Before we start, anything that is within the angle brackets ( < or > ) should be replaced as a whole. For example: <your-username> should be replaced to something like SooluThomas","title":"GitHub Cheatsheet"},{"location":"GH-cheatsheet/#table-of-contents","text":"Set up SSH keys Clone repository Create feature branches Check username and email in your local git Add, commit and push changes to feature branch Create Pull Request Pull changes from the main to feature branch","title":"Table of contents"},{"location":"GH-cheatsheet/#set-up-ssh-keys","text":"Most of GitHub's documentation is pretty good. So pointing to GH docs for 1. Check for existing SSH key 2. Generate new SSH key > Its easier to just follow the 3 steps mentioned under \"Generating a new SSH key\" section. 3. Add a new SSH key 4. Test your SSH connection","title":"Set up SSH keys"},{"location":"GH-cheatsheet/#clone-repository","text":"Once SSH keys are set up, in your terminal move to the which ever directory you want to have the local repo copy to live using the command cd Documents/<your-folder-path>/Capstone Then clone the repo using the command git clone git@github.com:NOAA-HES-Capstone/icedyno.git cd icedyno (Tip: the link was obtained from the repo -> green button called \"Code\" on top right of the repo -> SSH) Once this is done, you should be able to see the main branch (by default) locally.","title":"Clone repository"},{"location":"GH-cheatsheet/#create-feature-branches","text":"Create a branch using the command git checkout -b <your-initials>/<branch-name> # This command can show you which branch you are in # The * shows the current branch you are in git branch # you can use `git checkout main` to go to main branch and then # `git checkout <branch-name>` to go to different branch","title":"Create feature branches"},{"location":"GH-cheatsheet/#check-username-and-email-in-your-local-git","text":"This is an optional step but might be nice to have. This is a one-time thing to do. Run the following: git config user.name git config user.email If this is showing the correct github username and email, you are good. Otherwise, run git config user.name <your-username> git config user.email <your-registered-email>","title":"Check username and email in your local git"},{"location":"GH-cheatsheet/#add-commit-and-push-changes-to-feature-branch","text":"# This will show us a summary of the files changed when compared main branch git status # Add the files that were changed # It is always best to add the file names rather than to use `git add *` # so that unwanted files don't get added git add <path>/<file-name> # Commit your changes git commit -m \"Type out commit message with a one line summary briefing the changes\" # TIP: if you want to add more descriptive commit add -m \"descriptive message\" # after the one line summary message # [ALWAYS] Push commit to your branch git push origin <your-initials>/<branch-name>","title":"Add, commit and push changes to feature branch"},{"location":"GH-cheatsheet/#create-pull-request","text":"If you are pushing from a branch for the first time , the first commit will show a link that point to creating a pull request (PR) directly. It should be something like Enumerating objects: 4, done. Counting objects: 100% (4/4), done. Delta compression using up to 12 threads Compressing objects: 100% (3/3), done. Writing objects: 100% (3/3), 1.36 KiB | 1.36 MiB/s, done. Total 3 (delta 0), reused 0 (delta 0), pack-reused 0 remote: remote: Create a pull request for 'soo/add-gh-cheatsheat' on GitHub by visiting remote: https://github.com/NOAA-HES-Capstone/icedyno/pull/new/soo/add-gh-cheatsheat remote: To github.com:NOAA-HES-Capstone/icedyno.git * [new branch] soo/add-gh-cheatsheat -> soo/add-gh-cheatsheat Another way to open a PR is going to the repo itself and find your branch name under the branch selector in the repository. After you click on it, it should have a button to create a pull request.","title":"Create Pull Request"},{"location":"GH-cheatsheet/#pull-changes-from-the-main-to-feature-branch","text":"There could be cases where other PRs could be merged before ours and so we will need to pull those changes in our branch before we can merge or to make sure that our work doesn't break anything with the new changes made in the main branch. For this we can use # Fetch all the changes from remote to local git fetch # pull the changes from main to our feature branch git pull origin main If your are pulling for the first time in that repo, the might be a lot more that will be asked in the terminal and run the command for merge which is something like git config pull.rebase false Let's keep this file growing with the GitHub tips that you get know and would like to share with others.","title":"Pull changes from the main to feature branch"},{"location":"setup/","text":"Setup \u00b6 To get started, clone the repo, checkout this branch, using Linux install pixi with: curl -fsSL https://pixi.sh/install.sh | bash For Mac, install via homebrew with homebrew install pixi If using windows, install pixi with: iwr -useb https://pixi.sh/install.ps1 | iex See here for more info on pixi: https://pixi.sh/. Then to install the project and its dependencies, type: pixi install You could activate the virtual environment with pixi shell (so every command uses the virtual environment until you type exit ) or prefix your commands with pixi run inside the icedyno project folder (ex: pixi run pytest ). To set up the automatic linters (that run every time you commit your work), you would run: pixi run pre-commit install Testing the set up \u00b6 If you activated the pixi environment, type pytest . If not, type pixi run pytest . You should have one dummy test that runs on that command. What does it look like when the linters and pre-commit hooks run? \u00b6 After you've installed the pre-commit hooks and have changes to commit, this is what the process will look like for committing: You have changes to commit: Commit with a descriptive message: One-time setup of the linters: Our code was not already compliant with the linters, so they \"failed\" our commit and automatically changed things about our code to become compliant: Go ahead and inspect what got modified if you'd like: Add the changes and redo your commit command: Adding new dependencies \u00b6 Just write pixi add conda_or_pip_package_name . You can add multiple dependencies at once (which is better than one at a time, pixi will have to recompute work otherwise) by adding a space between the package names. I.e. pixi add package1 package2 package3 . You'll see that the pixi.toml and pixi.lock files will change after adding your new dependencies -- make sure to add those changes in your next commit! Removing a dependency \u00b6 pixi remove package_name","title":"Setup"},{"location":"setup/#setup","text":"To get started, clone the repo, checkout this branch, using Linux install pixi with: curl -fsSL https://pixi.sh/install.sh | bash For Mac, install via homebrew with homebrew install pixi If using windows, install pixi with: iwr -useb https://pixi.sh/install.ps1 | iex See here for more info on pixi: https://pixi.sh/. Then to install the project and its dependencies, type: pixi install You could activate the virtual environment with pixi shell (so every command uses the virtual environment until you type exit ) or prefix your commands with pixi run inside the icedyno project folder (ex: pixi run pytest ). To set up the automatic linters (that run every time you commit your work), you would run: pixi run pre-commit install","title":"Setup"},{"location":"setup/#testing-the-set-up","text":"If you activated the pixi environment, type pytest . If not, type pixi run pytest . You should have one dummy test that runs on that command.","title":"Testing the set up"},{"location":"setup/#what-does-it-look-like-when-the-linters-and-pre-commit-hooks-run","text":"After you've installed the pre-commit hooks and have changes to commit, this is what the process will look like for committing: You have changes to commit: Commit with a descriptive message: One-time setup of the linters: Our code was not already compliant with the linters, so they \"failed\" our commit and automatically changed things about our code to become compliant: Go ahead and inspect what got modified if you'd like: Add the changes and redo your commit command:","title":"What does it look like when the linters and pre-commit hooks run?"},{"location":"setup/#adding-new-dependencies","text":"Just write pixi add conda_or_pip_package_name . You can add multiple dependencies at once (which is better than one at a time, pixi will have to recompute work otherwise) by adding a space between the package names. I.e. pixi add package1 package2 package3 . You'll see that the pixi.toml and pixi.lock files will change after adding your new dependencies -- make sure to add those changes in your next commit!","title":"Adding new dependencies"},{"location":"setup/#removing-a-dependency","text":"pixi remove package_name","title":"Removing a dependency"},{"location":"workflow/","text":"IceDyno Dev Workflow \u00b6 This is where we should document how we should merge/rebase/squash/etc and things we should know while working.","title":"Workflow"},{"location":"workflow/#icedyno-dev-workflow","text":"This is where we should document how we should merge/rebase/squash/etc and things we should know while working.","title":"IceDyno Dev Workflow"}]}
\ No newline at end of file
diff --git a/setup.html b/setup.html
new file mode 100644
index 0000000..4d1cf0c
--- /dev/null
+++ b/setup.html
@@ -0,0 +1,1125 @@
+<!DOCTYPE html><html><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1"><style>body {
+  max-width: 980px;
+  margin: 16px auto;
+}
+
+body .markdown-body
+{
+  padding: 45px;
+}
+
+@font-face {
+  font-family: fontawesome-mini;
+  src: url(data:font/woff;charset=utf-8;base64,d09GRgABAAAAABE0AA8AAAAAHWwAAQAAAAAAAAAAAAAAAAAAAAAAAAAAAABHU1VCAAABWAAAADsAAABUIIslek9TLzIAAAGUAAAAQwAAAFY3d1HZY21hcAAAAdgAAACqAAACOvWLi0FjdnQgAAAChAAAABMAAAAgBtX/BGZwZ20AAAKYAAAFkAAAC3CKkZBZZ2FzcAAACCgAAAAIAAAACAAAABBnbHlmAAAIMAAABdQAAAjkYT9TNWhlYWQAAA4EAAAAMwAAADYQ6WvNaGhlYQAADjgAAAAfAAAAJAc6A1pobXR4AAAOWAAAACAAAAA0Kmz/7mxvY2EAAA54AAAAHAAAABwQPBJubWF4cAAADpQAAAAgAAAAIAEHC/NuYW1lAAAOtAAAAYQAAALxhQT4h3Bvc3QAABA4AAAAfgAAAMS3SYh9cHJlcAAAELgAAAB6AAAAhuVBK7x4nGNgZGBg4GIwYLBjYHJx8wlh4MtJLMljkGJgYYAAkDwymzEnMz2RgQPGA8qxgGkOIGaDiAIAJjsFSAB4nGNgZHZmnMDAysDAVMW0h4GBoQdCMz5gMGRkAooysDIzYAUBaa4pDA4Pwz+yMwf9z2KIYg5imAYUZgTJAQDcoQvQAHic7ZHNDYJAFIRnBXf94cDRIiyCKkCpwFCPJ092RcKNDoYKcN4+EmMPvpdvk539zQyAPYBCXEUJhBcCrJ5SQ9YLnLJe4qF5rdb+uWPDngNHTkta101pNyWa8lMhn6xx2dqUnW4q9YOIhAOOeueMSgsR/6ry+P7O5s6xVNg4chBsHUuFnWNJ8uZYwrw7chrsHXkODo7cB0dHOYCTY8kv0VE2WJKD6gOlWjsxAAB4nGNgQAMSEMgc9D8LhAESbAPdAHicrVZpd9NGFB15SZyELCULLWphxMRpsEYmbMGACUGyYyBdnK2VoIsUO+m+8Ynf4F/zZNpz6Dd+Wu8bLySQtOdwmpOjd+fN1czbZRJaktgL65GUmy/F1NYmjew8CemGTctRfCg7eyFlisnfBVEQrZbatx2HREQiULWusEQQ+x5ZmmR86FFGy7akV03KLT3pLlvjQb1V334aOsqxO6GkZjN0aD2yJVUYVaJIpj1S0qZlqPorSSu8v8LMV81QwohOImm8GcbQSN4bZ7TKaDW24yiKbLLcKFIkmuFBFHmU1RLn5IoJDMoHzZDyyqcR5cP8iKzYo5xWsEu20/y+L3mndzk/sV9vUbbkQB/Ijuzg7HQlX4RbW2HctJPtKFQRdtd3QmzZ7FT/Zo/ymkYDtysyvdCMYKl8hRArP6HM/iFZLZxP+ZJHo1qykRNB62VO7Es+gdbjiClxzRhZ0N3RCRHU/ZIzDPaYPh788d4plgsTAngcy3pHJZwIEylhczRJ2jByYCVliyqp9a6YOOV1WsRbwn7t2tGXzmjjUHdiPFsPHVs5UcnxaFKnmUyd2knNoykNopR0JnjMrwMoP6JJXm1jNYmVR9M4ZsaERCICLdxLU0EsO7GkKQTNoxm9uRumuXYtWqTJA/Xco/f05la4udNT2g70s0Z/VqdiOtgL0+lp5C/xadrlIkXp+ukZfkziQdYCMpEtNsOUgwdv/Q7Sy9eWHIXXBtju7fMrqH3WRPCkAfsb0B5P1SkJTIWYVYhWQGKta1mWydWsFqnI1HdDmla+rNMEinIcF8e+jHH9XzMzlpgSvt+J07MjLj1z7UsI0xx8m3U9mtepxXIBcWZ5TqdZlu/rNMfyA53mWZ7X6QhLW6ejLD/UaYHlRzodY3lBC5p038GQizDkAg6QMISlA0NYXoIhLBUMYbkIQ1gWYQjLJRjC8mMYwnIZhrC8rGXV1FNJ49qZWAZsQmBijh65zEXlaiq5VEK7aFRqQ54SbpVUFM+qf2WgXjzyhjmwFkiXyJpfMc6Vj0bl+NYVLW8aO1fAsepvH472OfFS1ouFPwX/1dZUJb1izcOTq/Abhp5sJ6o2qXh0TZfPVT26/l9UVFgL9BtIhVgoyrJscGcihI86nYZqoJVDzGzMPLTrdcuan8P9NzFCFlD9+DcUGgvcg05ZSVnt4KzV19uy3DuDcjgTLEkxN/P6VvgiI7PSfpFZyp6PfB5wBYxKZdhqA60VvNknMQ+Z3iTPBHFbUTZI2tjOBIkNHPOAefOdBCZh6qoN5E7hhg34BWFuwXknXKJ6oyyH7kXs8yik/Fun4kT2qGiMwLPZG2Gv70LKb3EMJDT5pX4MVBWhqRg1FdA0Um6oBl/G2bptQsYO9CMqdsOyrOLDxxb3lZJtGYR8pIjVo6Of1l6iTqrcfmYUl++dvgXBIDUxf3vfdHGQyrtayTJHbQNTtxqVU9eaQ+NVh+rmUfW94+wTOWuabronHnpf06rbwcVcLLD2bQ7SUiYX1PVhhQ2iy8WlUOplNEnvuAcYFhjQ71CKjf+r+th8nitVhdFxJN9O1LfR52AM/A/Yf0f1A9D3Y+hyDS7P95oTn2704WyZrqIX66foNzBrrblZugbc0HQD4iFHrY64yg18pwZxeqS5HOkh4GPdFeIBwCaAxeAT3bWM5lMAo/mMOT7A58xh0GQOgy3mMNhmzhrADnMY7DKHwR5zGHzBnHWAL5nDIGQOg4g5DJ4wJwB4yhwGXzGHwdfMYfANc+4DfMscBjFzGCTMYbCv6dYwzC1e0F2gtkFVoANTT1jcw+JQU2XI/o4Xhv29Qcz+wSCm/qjp9pD6Ey8M9WeDmPqLQUz9VdOdIfU3Xhjq7wYx9Q+DmPpMvxjLZQa/jHyXCgeUXWw+5++J9w/bxUC5AAEAAf//AA94nIVVX2hbZRQ/5/t7893s5ja9f7ouzdZ0TTqz3bRJmogbWya6bG6Cq0VbSV2ddIJjFtfIQHEig80Hda8yUN/0YQz8AyriiyD+xQd92R4HCnaCb3samnpumrpsCsLlfPf7zvedc37nL3CAtc/5W/wQZGA3tOBSY/g+TMjHmwzEoM1Q8+ZjRZY4oJhmBw5/YB6Za0yC5AkhlwA1A1yCBIBOwCII0Cj0U8BAMdUCzq05sKwkP7SlUY6fcJk4Fb/RyE79/6P5hjM/F4aZiXBoeMgzcqQ4Xi1hPqfDLG5FT+lchCVU3lYMyvuwhl1mqndQL0RsuloLywHtthLXI06OblTrhfWVnpSJ5+mwu/JdbtuN3IAnkW0LLMcRwaC7ktrlzridM6kVdyf9uO1UNBByI7JhwtG2sEwab07ORBeilWhqavJCqV0qzZTOl/7ZXQ5TbTcdcFelyGhhRDAQpdqp1FEX3w3cFTc1k9pJQkmm4ySCbSikxRP2QOfN+0tHS5MrpQuTU1Mk5nw0E5Xa0WvrOwDyGax9yB9ma6DAg82wHc43SAGTI4GjBWebOePAERFE8/AHaQpZASSTy8A4WwZiLQMQ82mFKATO0ILicRAoDm9p5P99E5b/fXG+kQYY3TYUuqmERWYoT0u/GNYL2q/4WB3LaVS+VynXsVYIcWw6DkCh3nX1D+VzlYN4LClF5yexSQos8exqZ3KVP+wtrC54u4Nznq6cq+xpMpUUnZ8FUYzE86ud0g28NOIv3Gj5/rmA3ABs7S/ywzFuQ4qyd6QxfNtiQIaEgp3w/entQg4Vcbqa16M5FfpeUB8t1+qeg7mI7cUyOe79wOk86gSxkVec4KPTX69++5x68Yubn5/F+w52z7u08sJX7fZXv8ekT/d2mILJxq6sn+SC6qEJknzLJCxyZEKwWVqYmAPBxBE/9DLeZiWHu7lcr/VytrCRuHojncNuTt9h46tmacmYisnSamdN2bZptcsmSysdVsy1PrOvOzF3xN64Rb937t/og9KHxYdcjIUqFAmIAHGHNzlns+RTPgeUYAQm9DwpNxfxbhhBHPaw3/gfTcXO2L+eJVIx5nsyGkvm9X4/f+bGkH45G0PaSjcMXTjcZyTvi3UdHoCDjQd3IDUVsgwYmUoJK/gp4JJxeRI0MKHZIkgynyIBqBTOUs6rOVCojvjZ4mCQz49ZMlMcp8QoYk6NoBfsxnJtsBohpa8iGJS+ZH7gU7NxME6cmF+t7cO9vB8d3jTWSct0ycW9ranXmolNDwmVkNnxe+8JtoztwS5rKJ0xWS95tQ/1zMYzg69MzUZnNtl1ofNbsml/OJm6f9wjRjpnu2o4MzHzn77IQkRd+1DjwMQ2pqSjGMMhyjrgTbBAKksuUm0iU7hI0aN2wOKOq7WYBSH0HGihj/jkiPxAfmwsEbfYrjMG+j3ij932Db/LV7I/xruNrhnroxjR9HRMb2nTvO0ZXOoHPk8H2ZhDPx93qcE/53sH5np/dkIP7zzhTVKdR/BAY/9ElkkR+A6lJGsqpJ4oQcTxpvBT3Kn58VkaJjgHyPEIws57xkaHh9KuVpDEpJZeMbZ5w/zBHi5NMQ4r5VphsFqID7TyB9eR4pX216c3AHxpdAwoqU9qg0ZJ6yVLKmMSz1iG2z27ifx18NkY0LPx1W/wCc2l5LrznrIsiKsqbmB78A9wIGx4tI8rjihVHJyY9pgMirenVq0yWg7Iw7eogG7ZgYM3qR9959A/fZkg6MnD/exlkmc+jWV4SB15XUR+eqC6l6ZmgPtN9z5JMfik05OV8ljylunJ4J+wA/FUaQSSKotsYsCWqaPBidBLcxkWx7XKFRIb45TGaEhjlF9uUVPqXOtcIwsXbBvfoZXIyRYFdkfnqjExH98xpnPczqzjX/uNdO1Y17Wpi5+6Ts8BXtjVFasp9KZ1mOiNbH65c5w6HgmyF2jFCZywM8mWjRc7T5Pmt0lRy7Y71+jYbpGyvwG4sH0XeJxjYGRgYADiwBB/53h+m68M3MwvgCIM1z5N/g6j///9v5H5BbMnkMvBwAQSBQCIcA9gAHicY2BkYGAO+p8FJF/8//v/F/MLBqAICuAFALYQB5kAeJxjfsHAwLwAiCNB+P9fbJjJmoGBMRUo/wKCAfO2EnQAAAAAANoBXgGcAgICVALaA1IDvAPkBAYEPARyAAEAAAANAF0ABAAAAAAAAgAUACQAcwAAAG4LcAAAAAB4nHWRzWrCQBSFT+pPqUIXLXTTzayKUohGKIibCoLuhbrrYtTRxCYZmYyKyz5Fd32HvlDfoO/QkziIFJtw9bvnnpl7ZwLgBt/wcHieGAf2UGd24Atcou+4RH3kuEweO66QXx1XyaHjGh6ROa7jFp/cwStfMVvhy7GHO+/e8QWuvcBxifqz4zL5xXGF/Oa4Sn53XMPE+3Bcx4P3M9DrvYmWoRWNQVN02kFXTPdCU4pSGQu5saE2meiLhU6timPtz3SSs9ypTCdqrJabWJoT5QQnymSRTkXgt0/UkUqVkVbN807ZdtmxdiEWRidi6HqItdErNbN+aO2612qd9sYAGmvsYRBhyUu0EGhQbfK/gzYCdElTOgSdB1eEFBIxFYkNV4RFJWPeZyyYpVQVHTHZx4y/yVGX2LGWFZri51TccUOn5B7nPefVCSPvGhVVwUl9znveO2KkhV8Wk82PZ8qwZf8OVcu1+fSmWCMw/HMOwXvKaysqM+p+cVuWag8tvv+c+xdd+4+teJxtjUEOwiAURJla24KliQfhUA2g/Sl+CKXx+loNrpzVezOLEY34Ron/0WhwQoszOvQYIKFwwQiNSbSBeO2SZ0tBP4j3zVjKNng32ZmtD1VVXCuOiw/pJ8S3WOU6l+K5UOTaDC4+2TjKMtN9KQf1ezLx/Sg/00FCvABHhjDjAAB4nGPw3sFwIihiIyNjX+QGxp0cDBwMyQUbGVidNjEwMmiBGJu5mBg5ICw+BjCLzWkX0wGgNCeQze60i8EBwmZmcNmowtgRGLHBoSNiI3OKy0Y1EG8XRwMDI4tDR3JIBEhJJBBs5mFi5NHawfi/dQNL70YmBhcADHYj9AAA) format('woff');
+}
+
+.markdown-body {
+  font-family: sans-serif;
+  -ms-text-size-adjust: 100%;
+  -webkit-text-size-adjust: 100%;
+  color: #333333;
+  overflow: hidden;
+  font-family: "Helvetica Neue", Helvetica, "Segoe UI", Arial, freesans, sans-serif;
+  font-size: 16px;
+  line-height: 1.6;
+  word-wrap: break-word;
+}
+
+.markdown-body a {
+  background: transparent;
+}
+
+.markdown-body a:active,
+.markdown-body a:hover {
+  outline: 0;
+}
+
+.markdown-body b,
+.markdown-body strong {
+  font-weight: bold;
+}
+
+.markdown-body mark {
+  background: #ff0;
+  color: #000;
+  font-style: italic;
+  font-weight: bold;
+}
+
+.markdown-body sub,
+.markdown-body sup {
+  font-size: 75%;
+  line-height: 0;
+  position: relative;
+  vertical-align: baseline;
+}
+.markdown-body sup {
+  top: -0.5em;
+}
+.markdown-body sub {
+  bottom: -0.25em;
+}
+
+.markdown-body h1 {
+  font-size: 2em;
+  margin: 0.67em 0;
+}
+
+.markdown-body img {
+  border: 0;
+}
+
+.markdown-body hr {
+  -moz-box-sizing: content-box;
+  box-sizing: content-box;
+  height: 0;
+}
+
+.markdown-body pre {
+  overflow: auto;
+}
+
+.markdown-body code,
+.markdown-body kbd,
+.markdown-body pre,
+.markdown-body samp {
+  font-family: monospace, monospace;
+  font-size: 1em;
+}
+
+.markdown-body input {
+  color: inherit;
+  font: inherit;
+  margin: 0;
+}
+
+.markdown-body html input[disabled] {
+  cursor: default;
+}
+
+.markdown-body input {
+  line-height: normal;
+}
+
+.markdown-body input[type="checkbox"] {
+  box-sizing: border-box;
+  padding: 0;
+}
+
+.markdown-body table {
+  border-collapse: collapse;
+  border-spacing: 0;
+}
+
+.markdown-body td,
+.markdown-body th {
+  padding: 0;
+}
+
+.markdown-body .codehilitetable,
+.markdown-body .highlighttable {
+  border: 0;
+  border-spacing: 0;
+}
+
+.markdown-body .codehilitetable tr,
+.markdown-body .highlighttable {
+  border: 0;
+}
+
+.markdown-body .codehilitetable pre,
+.markdown-body .codehilitetable div.codehilite,
+.markdown-body .highlighttable pre,
+.markdown-body .highlighttable div.highlight {
+  margin: 0;
+}
+
+.markdown-body .linenos,
+.markdown-body .code,
+.markdown-body .codehilitetable td,
+.markdown-body .highlighttable td {
+  border: 0;
+  padding: 0;
+}
+
+.markdown-body td:not(.linenos) .linenodiv {
+  padding: 0 !important;
+}
+
+.markdown-body .code {
+  width: 100%;
+}
+
+.markdown-body .linenos div pre,
+.markdown-body .linenodiv pre,
+.markdown-body .linenodiv {
+  border: 0;
+  -webkit-border-radius: 0;
+  -moz-border-radius: 0;
+  border-radius: 0;
+  -webkit-border-top-left-radius: 3px;
+  -webkit-border-bottom-left-radius: 3px;
+  -moz-border-radius-topleft: 3px;
+  -moz-border-radius-bottomleft: 3px;
+  border-top-left-radius: 3px;
+  border-bottom-left-radius: 3px;
+}
+
+.markdown-body .code div pre,
+.markdown-body .code div {
+  border: 0;
+  -webkit-border-radius: 0;
+  -moz-border-radius: 0;
+  border-radius: 0;
+  -webkit-border-top-right-radius: 3px;
+  -webkit-border-bottom-right-radius: 3px;
+  -moz-border-radius-topright: 3px;
+  -moz-border-radius-bottomright: 3px;
+  border-top-right-radius: 3px;
+  border-bottom-right-radius: 3px;
+}
+
+.markdown-body * {
+  -moz-box-sizing: border-box;
+  box-sizing: border-box;
+}
+
+.markdown-body input {
+  font: 13px Helvetica, arial, freesans, clean, sans-serif, "Segoe UI Emoji", "Segoe UI Symbol";
+  line-height: 1.4;
+}
+
+.markdown-body a {
+  color: #4183c4;
+  text-decoration: none;
+}
+
+.markdown-body a:hover,
+.markdown-body a:focus,
+.markdown-body a:active {
+  text-decoration: underline;
+}
+
+.markdown-body hr {
+  height: 0;
+  margin: 15px 0;
+  overflow: hidden;
+  background: transparent;
+  border: 0;
+  border-bottom: 1px solid #ddd;
+}
+
+.markdown-body hr:before,
+.markdown-body hr:after {
+  display: table;
+  content: " ";
+}
+
+.markdown-body hr:after {
+  clear: both;
+}
+
+.markdown-body h1,
+.markdown-body h2,
+.markdown-body h3,
+.markdown-body h4,
+.markdown-body h5,
+.markdown-body h6 {
+  margin-top: 15px;
+  margin-bottom: 15px;
+  line-height: 1.1;
+}
+
+.markdown-body h1 {
+  font-size: 30px;
+}
+
+.markdown-body h2 {
+  font-size: 21px;
+}
+
+.markdown-body h3 {
+  font-size: 16px;
+}
+
+.markdown-body h4 {
+  font-size: 14px;
+}
+
+.markdown-body h5 {
+  font-size: 12px;
+}
+
+.markdown-body h6 {
+  font-size: 11px;
+}
+
+.markdown-body blockquote {
+  margin: 0;
+}
+
+.markdown-body ul,
+.markdown-body ol {
+  padding: 0;
+  margin-top: 0;
+  margin-bottom: 0;
+}
+
+.markdown-body ol ol,
+.markdown-body ul ol {
+  list-style-type: lower-roman;
+}
+
+.markdown-body ul ul ol,
+.markdown-body ul ol ol,
+.markdown-body ol ul ol,
+.markdown-body ol ol ol {
+  list-style-type: lower-alpha;
+}
+
+.markdown-body dd {
+  margin-left: 0;
+}
+
+.markdown-body code,
+.markdown-body pre,
+.markdown-body samp {
+  font-family: Consolas, "Liberation Mono", Menlo, Courier, monospace;
+  font-size: 12px;
+}
+
+.markdown-body pre {
+  margin-top: 0;
+  margin-bottom: 0;
+}
+
+.markdown-body kbd {
+  background-color: #e7e7e7;
+  background-image: -moz-linear-gradient(#fefefe, #e7e7e7);
+  background-image: -webkit-linear-gradient(#fefefe, #e7e7e7);
+  background-image: linear-gradient(#fefefe, #e7e7e7);
+  background-repeat: repeat-x;
+  border-radius: 2px;
+  border: 1px solid #cfcfcf;
+  color: #000;
+  padding: 3px 5px;
+  line-height: 10px;
+  font: 11px Consolas, "Liberation Mono", Menlo, Courier, monospace;
+  display: inline-block;
+}
+
+.markdown-body>*:first-child {
+  margin-top: 0 !important;
+}
+
+.markdown-body>*:last-child {
+  margin-bottom: 0 !important;
+}
+
+.markdown-body .headerlink {
+  font: normal 400 16px fontawesome-mini;
+  vertical-align: middle;
+  margin-left: -16px;
+  float: left;
+  display: inline-block;
+  text-decoration: none;
+  opacity: 0;
+  color: #333;
+}
+
+.markdown-body .headerlink:focus {
+  outline: none;
+}
+
+.markdown-body h1 .headerlink {
+  margin-top: 0.8rem;
+}
+
+.markdown-body h2 .headerlink,
+.markdown-body h3 .headerlink {
+  margin-top: 0.6rem;
+}
+
+.markdown-body h4 .headerlink {
+  margin-top: 0.2rem;
+}
+
+.markdown-body h5 .headerlink,
+.markdown-body h6 .headerlink {
+  margin-top: 0;
+}
+
+.markdown-body .headerlink:hover,
+.markdown-body h1:hover .headerlink,
+.markdown-body h2:hover .headerlink,
+.markdown-body h3:hover .headerlink,
+.markdown-body h4:hover .headerlink,
+.markdown-body h5:hover .headerlink,
+.markdown-body h6:hover .headerlink {
+  opacity: 1;
+  text-decoration: none;
+}
+
+.markdown-body h1 {
+  padding-bottom: 0.3em;
+  font-size: 2.25em;
+  line-height: 1.2;
+  border-bottom: 1px solid #eee;
+}
+
+.markdown-body h2 {
+  padding-bottom: 0.3em;
+  font-size: 1.75em;
+  line-height: 1.225;
+  border-bottom: 1px solid #eee;
+}
+
+.markdown-body h3 {
+  font-size: 1.5em;
+  line-height: 1.43;
+}
+
+.markdown-body h4 {
+  font-size: 1.25em;
+}
+
+.markdown-body h5 {
+  font-size: 1em;
+}
+
+.markdown-body h6 {
+  font-size: 1em;
+  color: #777;
+}
+
+.markdown-body p,
+.markdown-body blockquote,
+.markdown-body ul,
+.markdown-body ol,
+.markdown-body dl,
+.markdown-body table,
+.markdown-body pre,
+.markdown-body .admonition {
+  margin-top: 0;
+  margin-bottom: 16px;
+}
+
+.markdown-body hr {
+  height: 4px;
+  padding: 0;
+  margin: 16px 0;
+  background-color: #e7e7e7;
+  border: 0 none;
+}
+
+.markdown-body ul,
+.markdown-body ol {
+  padding-left: 2em;
+}
+
+.markdown-body ul ul,
+.markdown-body ul ol,
+.markdown-body ol ol,
+.markdown-body ol ul {
+  margin-top: 0;
+  margin-bottom: 0;
+}
+
+.markdown-body li>p {
+  margin-top: 16px;
+}
+
+.markdown-body dl {
+  padding: 0;
+}
+
+.markdown-body dl dt {
+  padding: 0;
+  margin-top: 16px;
+  font-size: 1em;
+  font-style: italic;
+  font-weight: bold;
+}
+
+.markdown-body dl dd {
+  padding: 0 16px;
+  margin-bottom: 16px;
+}
+
+.markdown-body blockquote {
+  padding: 0 15px;
+  color: #777;
+  border-left: 4px solid #ddd;
+}
+
+.markdown-body blockquote>:first-child {
+  margin-top: 0;
+}
+
+.markdown-body blockquote>:last-child {
+  margin-bottom: 0;
+}
+
+.markdown-body table {
+  display: block;
+  width: 100%;
+  overflow: auto;
+  word-break: normal;
+  word-break: keep-all;
+}
+
+.markdown-body table th {
+  font-weight: bold;
+}
+
+.markdown-body table th,
+.markdown-body table td {
+  padding: 6px 13px;
+  border: 1px solid #ddd;
+}
+
+.markdown-body table tr {
+  background-color: #fff;
+  border-top: 1px solid #ccc;
+}
+
+.markdown-body table tr:nth-child(2n) {
+  background-color: #f8f8f8;
+}
+
+.markdown-body img {
+  max-width: 100%;
+  -moz-box-sizing: border-box;
+  box-sizing: border-box;
+}
+
+.markdown-body code,
+.markdown-body samp {
+  padding: 0;
+  padding-top: 0.2em;
+  padding-bottom: 0.2em;
+  margin: 0;
+  font-size: 85%;
+  border-radius: 3px;
+}
+
+.markdown-body code:not(.highlight):not(.codehilite), .markdown-body samp {
+  background-color: rgba(0,0,0,0.04);
+}
+
+.markdown-body code:before,
+.markdown-body code:after {
+  letter-spacing: -0.2em;
+  content: "\00a0";
+}
+
+.markdown-body pre>code {
+  padding: 0;
+  margin: 0;
+  font-size: 100%;
+  word-break: normal;
+  white-space: pre;
+  background: transparent;
+  border: 0;
+}
+
+.markdown-body .codehilite,
+.markdown-body .highlight {
+  margin-bottom: 16px;
+}
+
+.markdown-body .codehilite pre,
+.markdown-body .highlight pre,
+.markdown-body pre {
+  padding: 16px;
+  overflow: auto;
+  font-size: 85%;
+  line-height: 1.45;
+}
+
+.markdown-body .codehilite,
+.markdown-body .highlight,
+.markdown-body pre {
+  border-radius: 3px;
+}
+
+.markdown-body :not(.highlight) > pre {
+  background-color: #f7f7f7;
+}
+
+.markdown-body .codehilite pre,
+.markdown-body .highlight pre {
+  margin-bottom: 0;
+  word-break: normal;
+}
+
+.markdown-body pre {
+  word-wrap: normal;
+}
+
+.markdown-body pre code {
+  display: inline;
+  max-width: initial;
+  padding: 0;
+  margin: 0;
+  overflow: initial;
+  line-height: inherit;
+  word-wrap: normal;
+  background-color: transparent;
+  border: 0;
+}
+
+.markdown-body pre code:before,
+.markdown-body pre code:after {
+  content: normal;
+}
+
+/* Admonition */
+.markdown-body .admonition {
+  -webkit-border-radius: 3px;
+  -moz-border-radius: 3px;
+  position: relative;
+  border-radius: 3px;
+  border: 1px solid #e0e0e0;
+  border-left: 6px solid #333;
+  padding: 10px 10px 10px 30px;
+}
+
+.markdown-body .admonition table {
+  color: #333;
+}
+
+.markdown-body .admonition p {
+  padding: 0;
+}
+
+.markdown-body .admonition-title {
+  font-weight: bold;
+  margin: 0;
+}
+
+.markdown-body .admonition>.admonition-title {
+  color: #333;
+}
+
+.markdown-body .attention>.admonition-title {
+  color: #a6d796;
+}
+
+.markdown-body .caution>.admonition-title {
+  color: #d7a796;
+}
+
+.markdown-body .hint>.admonition-title {
+  color: #96c6d7;
+}
+
+.markdown-body .danger>.admonition-title {
+  color: #c25f77;
+}
+
+.markdown-body .question>.admonition-title {
+  color: #96a6d7;
+}
+
+.markdown-body .note>.admonition-title {
+  color: #d7c896;
+}
+
+.markdown-body .admonition:before,
+.markdown-body .attention:before,
+.markdown-body .caution:before,
+.markdown-body .hint:before,
+.markdown-body .danger:before,
+.markdown-body .question:before,
+.markdown-body .note:before {
+  font: normal normal 16px fontawesome-mini;
+  -moz-osx-font-smoothing: grayscale;
+  -webkit-user-select: none;
+  -moz-user-select: none;
+  -ms-user-select: none;
+  user-select: none;
+  line-height: 1.5;
+  color: #333;
+  position: absolute;
+  left: 0;
+  top: 0;
+  padding-top: 10px;
+  padding-left: 10px;
+}
+
+.markdown-body .admonition:before {
+  content: "\f056\00a0";
+  color: 333;
+}
+
+.markdown-body .attention:before {
+  content: "\f058\00a0";
+  color: #a6d796;
+}
+
+.markdown-body .caution:before {
+  content: "\f06a\00a0";
+  color: #d7a796;
+}
+
+.markdown-body .hint:before {
+  content: "\f05a\00a0";
+  color: #96c6d7;
+}
+
+.markdown-body .danger:before {
+  content: "\f057\00a0";
+  color: #c25f77;
+}
+
+.markdown-body .question:before {
+  content: "\f059\00a0";
+  color: #96a6d7;
+}
+
+.markdown-body .note:before {
+  content: "\f040\00a0";
+  color: #d7c896;
+}
+
+.markdown-body .admonition::after {
+  content: normal;
+}
+
+.markdown-body .attention {
+  border-left: 6px solid #a6d796;
+}
+
+.markdown-body .caution {
+  border-left: 6px solid #d7a796;
+}
+
+.markdown-body .hint {
+  border-left: 6px solid #96c6d7;
+}
+
+.markdown-body .danger {
+  border-left: 6px solid #c25f77;
+}
+
+.markdown-body .question {
+  border-left: 6px solid #96a6d7;
+}
+
+.markdown-body .note {
+  border-left: 6px solid #d7c896;
+}
+
+.markdown-body .admonition>*:first-child {
+  margin-top: 0 !important;
+}
+
+.markdown-body .admonition>*:last-child {
+  margin-bottom: 0 !important;
+}
+
+/* progress bar*/
+.markdown-body .progress {
+  display: block;
+  width: 300px;
+  margin: 10px 0;
+  height: 24px;
+  -webkit-border-radius: 3px;
+  -moz-border-radius: 3px;
+  border-radius: 3px;
+  background-color: #ededed;
+  position: relative;
+  box-shadow: inset -1px 1px 3px rgba(0, 0, 0, .1);
+}
+
+.markdown-body .progress-label {
+  position: absolute;
+  text-align: center;
+  font-weight: bold;
+  width: 100%; margin: 0;
+  line-height: 24px;
+  color: #333;
+  text-shadow: 1px 1px 0 #fefefe, -1px -1px 0 #fefefe, -1px 1px 0 #fefefe, 1px -1px 0 #fefefe, 0 1px 0 #fefefe, 0 -1px 0 #fefefe, 1px 0 0 #fefefe, -1px 0 0 #fefefe, 1px 1px 2px #000;
+  -webkit-font-smoothing: antialiased !important;
+  white-space: nowrap;
+  overflow: hidden;
+}
+
+.markdown-body .progress-bar {
+  height: 24px;
+  float: left;
+  -webkit-border-radius: 3px;
+  -moz-border-radius: 3px;
+  border-radius: 3px;
+  background-color: #96c6d7;
+  box-shadow: inset 0 1px 0 rgba(255, 255, 255, .5), inset 0 -1px 0 rgba(0, 0, 0, .1);
+  background-size: 30px 30px;
+  background-image: -webkit-linear-gradient(
+    135deg, rgba(255, 255, 255, .4) 27%,
+    transparent 27%,
+    transparent 52%, rgba(255, 255, 255, .4) 52%,
+    rgba(255, 255, 255, .4) 77%,
+    transparent 77%, transparent
+  );
+  background-image: -moz-linear-gradient(
+    135deg,
+    rgba(255, 255, 255, .4) 27%, transparent 27%,
+    transparent 52%, rgba(255, 255, 255, .4) 52%,
+    rgba(255, 255, 255, .4) 77%, transparent 77%,
+    transparent
+  );
+  background-image: -ms-linear-gradient(
+    135deg,
+    rgba(255, 255, 255, .4) 27%, transparent 27%,
+    transparent 52%, rgba(255, 255, 255, .4) 52%,
+    rgba(255, 255, 255, .4) 77%, transparent 77%,
+    transparent
+  );
+  background-image: -o-linear-gradient(
+    135deg,
+    rgba(255, 255, 255, .4) 27%, transparent 27%,
+    transparent 52%, rgba(255, 255, 255, .4) 52%,
+    rgba(255, 255, 255, .4) 77%, transparent 77%,
+    transparent
+  );
+  background-image: linear-gradient(
+    135deg,
+    rgba(255, 255, 255, .4) 27%, transparent 27%,
+    transparent 52%, rgba(255, 255, 255, .4) 52%,
+    rgba(255, 255, 255, .4) 77%, transparent 77%,
+    transparent
+  );
+}
+
+.markdown-body .progress-100plus .progress-bar {
+  background-color: #a6d796;
+}
+
+.markdown-body .progress-80plus .progress-bar {
+  background-color: #c6d796;
+}
+
+.markdown-body .progress-60plus .progress-bar {
+  background-color: #d7c896;
+}
+
+.markdown-body .progress-40plus .progress-bar {
+  background-color: #d7a796;
+}
+
+.markdown-body .progress-20plus .progress-bar {
+  background-color: #d796a6;
+}
+
+.markdown-body .progress-0plus .progress-bar {
+  background-color: #c25f77;
+}
+
+.markdown-body .candystripe-animate .progress-bar{
+  -webkit-animation: animate-stripes 3s linear infinite;
+  -moz-animation: animate-stripes 3s linear infinite;
+  animation: animate-stripes 3s linear infinite;
+}
+
+@-webkit-keyframes animate-stripes {
+  0% {
+    background-position: 0 0;
+  }
+
+  100% {
+    background-position: 60px 0;
+  }
+}
+
+@-moz-keyframes animate-stripes {
+  0% {
+    background-position: 0 0;
+  }
+
+  100% {
+    background-position: 60px 0;
+  }
+}
+
+@keyframes animate-stripes {
+  0% {
+    background-position: 0 0;
+  }
+
+  100% {
+    background-position: 60px 0;
+  }
+}
+
+.markdown-body .gloss .progress-bar {
+  box-shadow:
+    inset 0 4px 12px rgba(255, 255, 255, .7),
+    inset 0 -12px 0 rgba(0, 0, 0, .05);
+}
+
+/* MultiMarkdown Critic Blocks */
+.markdown-body .critic_mark {
+  background: #ff0;
+}
+
+.markdown-body .critic_delete {
+  color: #c82829;
+  text-decoration: line-through;
+}
+
+.markdown-body .critic_insert {
+  color: #718c00 ;
+  text-decoration: underline;
+}
+
+.markdown-body .critic_comment {
+  color: #8e908c;
+  font-style: italic;
+}
+
+.markdown-body .headeranchor {
+  font: normal normal 16px fontawesome-mini;
+  line-height: 1;
+  display: inline-block;
+  text-decoration: none;
+  -webkit-font-smoothing: antialiased;
+  -moz-osx-font-smoothing: grayscale;
+  -webkit-user-select: none;
+  -moz-user-select: none;
+  -ms-user-select: none;
+  user-select: none;
+}
+
+.headeranchor:before {
+  content: '\e157';
+}
+
+.markdown-body .task-list-item {
+  list-style-type: none;
+}
+
+.markdown-body .task-list-item+.task-list-item {
+  margin-top: 3px;
+}
+
+.markdown-body .task-list-item input {
+  margin: 0 4px 0.25em -20px;
+  vertical-align: middle;
+}
+
+.markdown-body diagram-div, .markdown-body div.uml-sequence-diagram, .markdown-body, div.uml-flowchart {
+  overflow: auto;
+}
+
+/* Media */
+@media only screen and (min-width: 480px) {
+  .markdown-body {
+    font-size:14px;
+  }
+}
+
+@media only screen and (min-width: 768px) {
+  .markdown-body {
+    font-size:16px;
+  }
+}
+
+@media print {
+  .markdown-body * {
+    background: transparent !important;
+    color: black !important;
+    filter:none !important;
+    -ms-filter: none !important;
+  }
+
+  .markdown-body {
+    font-size:12pt;
+    max-width:100%;
+    outline:none;
+    border: 0;
+  }
+
+  .markdown-body a,
+  .markdown-body a:visited {
+    text-decoration: underline;
+  }
+
+  .markdown-body .headeranchor-link {
+    display: none;
+  }
+
+  .markdown-body a[href]:after {
+    content: " (" attr(href) ")";
+  }
+
+  .markdown-body abbr[title]:after {
+    content: " (" attr(title) ")";
+  }
+
+  .markdown-body .ir a:after,
+  .markdown-body a[href^="javascript:"]:after,
+  .markdown-body a[href^="#"]:after {
+    content: "";
+  }
+
+  .markdown-body pre {
+    white-space: pre;
+    white-space: pre-wrap;
+    word-wrap: break-word;
+  }
+
+  .markdown-body pre,
+  .markdown-body blockquote {
+    border: 1px solid #999;
+    padding-right: 1em;
+    page-break-inside: avoid;
+  }
+
+  .markdown-body .progress,
+  .markdown-body .progress-bar {
+    -moz-box-shadow: none;
+    -webkit-box-shadow: none;
+    box-shadow: none;
+  }
+
+  .markdown-body .progress {
+    border: 1px solid #ddd;
+  }
+
+  .markdown-body .progress-bar {
+    height: 22px;
+    border-right: 1px solid #ddd;
+  }
+
+  .markdown-body tr,
+  .markdown-body img {
+    page-break-inside: avoid;
+  }
+
+  .markdown-body img {
+    max-width: 100% !important;
+  }
+
+  .markdown-body p,
+  .markdown-body h2,
+  .markdown-body h3 {
+    orphans: 3;
+    widows: 3;
+  }
+
+  .markdown-body h2,
+  .markdown-body h3 {
+    page-break-after: avoid;
+  }
+}
+</style><style>/*GitHub*/
+.highlight {background-color:#f7f7f7;color:#333333;}
+.highlight .hll {background-color:#ffffcc;}
+.highlight .c{color:#999988;font-style:italic}
+.highlight .err{color:#a61717;background-color:#e3d2d2}
+.highlight .k{font-weight:bold}
+.highlight .o{font-weight:bold}
+.highlight .cm{color:#999988;font-style:italic}
+.highlight .cp{color:#999999;font-weight:bold}
+.highlight .c1{color:#999988;font-style:italic}
+.highlight .cs{color:#999999;font-weight:bold;font-style:italic}
+.highlight .gd{color:#000000;background-color:#ffdddd}
+.highlight .ge{font-style:italic}
+.highlight .gr{color:#aa0000}
+.highlight .gh{color:#999999}
+.highlight .gi{color:#000000;background-color:#ddffdd}
+.highlight .go{color:#888888}
+.highlight .gp{color:#555555}
+.highlight .gs{font-weight:bold}
+.highlight .gu{color:#800080;font-weight:bold}
+.highlight .gt{color:#aa0000}
+.highlight .kc{font-weight:bold}
+.highlight .kd{font-weight:bold}
+.highlight .kn{font-weight:bold}
+.highlight .kp{font-weight:bold}
+.highlight .kr{font-weight:bold}
+.highlight .kt{color:#445588;font-weight:bold}
+.highlight .m{color:#009999}
+.highlight .s{color:#dd1144}
+.highlight .n{color:#333333}
+.highlight .na{color:teal}
+.highlight .nb{color:#0086b3}
+.highlight .nc{color:#445588;font-weight:bold}
+.highlight .no{color:teal}
+.highlight .ni{color:purple}
+.highlight .ne{color:#990000;font-weight:bold}
+.highlight .nf{color:#990000;font-weight:bold}
+.highlight .nn{color:#555555}
+.highlight .nt{color:navy}
+.highlight .nv{color:teal}
+.highlight .ow{font-weight:bold}
+.highlight .w{color:#bbbbbb}
+.highlight .mf{color:#009999}
+.highlight .mh{color:#009999}
+.highlight .mi{color:#009999}
+.highlight .mo{color:#009999}
+.highlight .sb{color:#dd1144}
+.highlight .sc{color:#dd1144}
+.highlight .sd{color:#dd1144}
+.highlight .s2{color:#dd1144}
+.highlight .se{color:#dd1144}
+.highlight .sh{color:#dd1144}
+.highlight .si{color:#dd1144}
+.highlight .sx{color:#dd1144}
+.highlight .sr{color:#009926}
+.highlight .s1{color:#dd1144}
+.highlight .ss{color:#990073}
+.highlight .bp{color:#999999}
+.highlight .vc{color:teal}
+.highlight .vg{color:teal}
+.highlight .vi{color:teal}
+.highlight .il{color:#009999}
+.highlight .gc{color:#999;background-color:#EAF2F5}
+</style><title>setup</title></head><body><article class="markdown-body"><h1 id="setup">Setup<a class="headerlink" href="#setup" title="Permanent link"></a></h1>
+<p>To get started, clone the repo, checkout this branch, using Linux or Mac install pixi with:<br />
+<code>curl -fsSL https://pixi.sh/install.sh | bash</code></p>
+<p>If using windows, install pixi with:<br />
+<code>iwr -useb https://pixi.sh/install.ps1 | iex</code></p>
+<p>See here for more info on pixi: <a href="https://pixi.sh/">https://pixi.sh/</a>.</p>
+<p>Then to install the project and its dependencies, type:<br />
+<code>pixi install</code></p>
+<p>You could activate the virtual environment with <code>pixi shell</code> (so every command uses the virtual environment until you type <code>exit</code>) or prefix your commands with <code>pixi run</code> inside the icedyno project folder (ex: <code>pixi run pytest</code>).</p>
+<p>To set up the automatic linters (that run every time you commit your work), you would run:<br />
+<code>pixi run pre-commit install</code></p>
+<p><img alt="install_pre_commit" src="/home/bacon/code/personal/icedyno/docs/images/install_pre_commit.png" /></p>
+<h2 id="testing-the-set-up">Testing the set up<a class="headerlink" href="#testing-the-set-up" title="Permanent link"></a></h2>
+<p>If you activated the pixi environment, type <code>pytest</code>. If not, type <code>pixi run pytest</code>. You should have one dummy test that runs on that command.</p>
+<h2 id="what-does-it-look-like-when-the-linters-and-pre-commit-hooks-run">What does it look like when the linters and pre-commit hooks run?<a class="headerlink" href="#what-does-it-look-like-when-the-linters-and-pre-commit-hooks-run" title="Permanent link"></a></h2>
+<p>After you&rsquo;ve installed the pre-commit hooks and have changes to commit, this is what the process will look like for committing:</p>
+<ol>
+<li>
+<p>You have changes to commit:<br />
+<img alt="added_changes" src="/home/bacon/code/personal/icedyno/docs/images/added_changes.png" /></p>
+</li>
+<li>
+<p>Commit with a descriptive message:<br />
+<img alt="descriptive_commit" src="/home/bacon/code/personal/icedyno/docs/images/descriptive_commit.png" /></p>
+</li>
+<li>
+<p>One-time setup of the linters:<br />
+<img alt="pre_commit_hook_installation" src="/home/bacon/code/personal/icedyno/docs/images/pre_commit_hook_installation.png" /></p>
+</li>
+<li>
+<p>Our code was not already compliant with the linters, so they &ldquo;failed&rdquo; our commit and automatically changed things about our code to become compliant:<br />
+<img alt="failed_commit" src="/home/bacon/code/personal/icedyno/docs/images/failed_commit.png" /></p>
+</li>
+<li>
+<p>Go ahead and inspect what got modified if you&rsquo;d like:<br />
+<img alt="inspect_changes" src="/home/bacon/code/personal/icedyno/docs/images/inspect_changes.png" /></p>
+</li>
+<li>
+<p>Add the changes and redo your commit command:<br />
+<img alt="final_commit" src="/home/bacon/code/personal/icedyno/docs/images/final_commit.png" /></p>
+</li>
+</ol>
+<h2 id="adding-new-dependencies">Adding new dependencies<a class="headerlink" href="#adding-new-dependencies" title="Permanent link"></a></h2>
+<p>Just write <code>pixi add conda_or_pip_package_name</code>. You can add multiple dependencies at once (which is better than one at a time, <code>pixi</code> will have to recompute work otherwise) by adding a space between the package names. I.e. <code>pixi add package1 package2 package3</code>.</p>
+<p>You&rsquo;ll see that the <code>pixi.toml</code> and <code>pixi.lock</code> files will change after adding your new dependencies &ndash; make sure to add those changes in your next commit!</p>
+<h2 id="removing-a-dependency">Removing a dependency<a class="headerlink" href="#removing-a-dependency" title="Permanent link"></a></h2>
+<p><code>pixi remove package_name</code></p></article></body></html>
\ No newline at end of file
diff --git a/setup/index.html b/setup/index.html
index 178551f..d943d6e 100644
--- a/setup/index.html
+++ b/setup/index.html
@@ -105,8 +105,10 @@
                     <div class="col-md-9" role="main">
 
 <h1 id="setup">Setup<a class="headerlink" href="#setup" title="Permanent link">&para;</a></h1>
-<p>To get started, clone the repo, checkout this branch, using Linux or Mac install pixi with:<br />
+<p>To get started, clone the repo, checkout this branch, using Linux install pixi with:<br />
 <code>curl -fsSL https://pixi.sh/install.sh | bash</code></p>
+<p>For Mac, install via homebrew with
+<code>homebrew install pixi</code></p>
 <p>If using windows, install pixi with:<br />
 <code>iwr -useb https://pixi.sh/install.ps1 | iex</code></p>
 <p>See here for more info on pixi: https://pixi.sh/.</p>
diff --git a/sitemap.xml.gz b/sitemap.xml.gz
index 1bd20ba12f84ff2a7673a550b5c35806673f0e4a..b360e6471fd6d0ab301904823dccd8f7f6ecea39 100644
GIT binary patch
delta 12
Tcmb=gXOr*d;Hb2j$W{pe7Yzf1

delta 12
Tcmb=gXOr*d;CN^?k*yK{84UyK