From 307d81f6e76d32713c7af707d05f6e927ccb500e Mon Sep 17 00:00:00 2001 From: LisaM-kiwi Date: Fri, 20 Mar 2026 09:51:52 -0400 Subject: [PATCH 1/7] added links and new page --- README.md | 2 +- docs/_src/_wiki/Onboarding-videos.rst | 50 +++++++++++++++++++++++++++ docs/_src/_wiki/onboarding.rst | 3 +- docs/_src/index.rst | 1 + 4 files changed, 53 insertions(+), 3 deletions(-) create mode 100644 docs/_src/_wiki/Onboarding-videos.rst diff --git a/README.md b/README.md index 0742e29fba..3b2bd7e80d 100644 --- a/README.md +++ b/README.md @@ -55,7 +55,7 @@ pip install . ```bash python main.py ``` -6. **Learn more** if you have further questions read through the documentation on our [GitHub Pages site](https://ruminantfarmsystems.github.io/RuFaS/) +6. **Learn more** if you have further questions read through the documentation on our [GitHub Pages site](https://ruminantfarmsystems.github.io/RuFaS/) or watch our [onboarding video series](https://www.youtube.com/playlist?list=PLqq6i4QOoueR-a2mxVX3Gc78s1wvTRfr1). --- diff --git a/docs/_src/_wiki/Onboarding-videos.rst b/docs/_src/_wiki/Onboarding-videos.rst new file mode 100644 index 0000000000..c6b96623f3 --- /dev/null +++ b/docs/_src/_wiki/Onboarding-videos.rst @@ -0,0 +1,50 @@ +Onboarding Videos +================= + +Introduction +~~~~~~~~~~~~ + +The `onboarding video series `_ +introduces users to the RuFaS whole-farm modeling platform and open-source +collaboration practices needed to begin working with the model. + +Users will learn how to do the following: + + - Install and run RuFaS + - Contribute through github + - Build and troubleshoot simulations + - Navigate the codebase + - Basic troubleshooting + +Series Videos +^^^^^^^^^^^^^ + +1. `Onboarding Introduction `_ + This introductory video provides a high-level overview of the tools and + technologies needed to begin working with RuFaS. It also explains the + basics of open-source collaboration and github, and shows where to access + the RuFaS repository. + +2. `Guide to Pyton, IDEs, GitHub, and RuFaS `_ + This video walks through setting up your workstation to run RuFaS by introducing + the key tools and explaining how they support working with the model. It + demonstrates how to install the programs on MacOS and Windows, setting up a + virtual environment, install RuFaS, and run a test to confirm everything is + working correctly. + +3. `GitHub Tour, Communication Guidelines, and Pull Requests `_ + This video introduces how RuFaS uses github for collaboration, including where + to find support, documentation, and project information. It walks through + RuFaS communication guidelines and the pull request process. + +4. `End to End Simulation and Data Visualization `_ + This video walks through how to run a RuFaS simulation by creating biophysical + input files, linking metadata and file paths, and setting up output filters to + examine results. It also guides users through completing a full practice + scenario, troubleshooting common eras and warnings, and exploring options for + customizing solutions. + +5. `RuFaS Deeper Dive `_ + This video provides a deeper look at the RuFaS code, beginning with a core + simulation structure and how to find something specific in the code. It also + shows how inputs and outputs are connected and demonstrates debugging basics. \ No newline at end of file diff --git a/docs/_src/_wiki/onboarding.rst b/docs/_src/_wiki/onboarding.rst index 62b980bfd0..12cde4ec74 100644 --- a/docs/_src/_wiki/onboarding.rst +++ b/docs/_src/_wiki/onboarding.rst @@ -930,8 +930,7 @@ Additional Materials -------------------- - Now that you’re familiar with the basics, we encourage you to review - the full recording of the `onboarding - session `__ + the full `onboarding video series `__ for more details. - If using VS Code or PyCharm and unsure of how to proceed with setting diff --git a/docs/_src/index.rst b/docs/_src/index.rst index 360002636c..53cdf1b2ed 100644 --- a/docs/_src/index.rst +++ b/docs/_src/index.rst @@ -33,6 +33,7 @@ Navigation :caption: Getting Started: _wiki/onboarding + _wiki/Onboarding-videos .. toctree:: :maxdepth: 2 From 4ddfc20f39f1a044cee3f89dd33af9ae5acaffc9 Mon Sep 17 00:00:00 2001 From: LisaM-kiwi Date: Fri, 20 Mar 2026 10:00:21 -0400 Subject: [PATCH 2/7] edited page --- docs/_src/_wiki/Onboarding-videos.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/docs/_src/_wiki/Onboarding-videos.rst b/docs/_src/_wiki/Onboarding-videos.rst index c6b96623f3..e9cc22faf8 100644 --- a/docs/_src/_wiki/Onboarding-videos.rst +++ b/docs/_src/_wiki/Onboarding-videos.rst @@ -20,12 +20,14 @@ Series Videos ^^^^^^^^^^^^^ 1. `Onboarding Introduction `_ + This introductory video provides a high-level overview of the tools and technologies needed to begin working with RuFaS. It also explains the basics of open-source collaboration and github, and shows where to access the RuFaS repository. 2. `Guide to Pyton, IDEs, GitHub, and RuFaS `_ + This video walks through setting up your workstation to run RuFaS by introducing the key tools and explaining how they support working with the model. It demonstrates how to install the programs on MacOS and Windows, setting up a @@ -33,11 +35,13 @@ Series Videos working correctly. 3. `GitHub Tour, Communication Guidelines, and Pull Requests `_ + This video introduces how RuFaS uses github for collaboration, including where to find support, documentation, and project information. It walks through RuFaS communication guidelines and the pull request process. 4. `End to End Simulation and Data Visualization `_ + This video walks through how to run a RuFaS simulation by creating biophysical input files, linking metadata and file paths, and setting up output filters to examine results. It also guides users through completing a full practice @@ -45,6 +49,7 @@ Series Videos customizing solutions. 5. `RuFaS Deeper Dive `_ + This video provides a deeper look at the RuFaS code, beginning with a core simulation structure and how to find something specific in the code. It also shows how inputs and outputs are connected and demonstrates debugging basics. \ No newline at end of file From 005e599d9dc0d75bdc5cb9810c2dc8b8b2de9a29 Mon Sep 17 00:00:00 2001 From: LisaM-kiwi Date: Fri, 20 Mar 2026 10:07:11 -0400 Subject: [PATCH 3/7] Update Onboarding-videos.rst --- docs/_src/_wiki/Onboarding-videos.rst | 50 +++++++++++++-------------- 1 file changed, 25 insertions(+), 25 deletions(-) diff --git a/docs/_src/_wiki/Onboarding-videos.rst b/docs/_src/_wiki/Onboarding-videos.rst index e9cc22faf8..fea9c35a81 100644 --- a/docs/_src/_wiki/Onboarding-videos.rst +++ b/docs/_src/_wiki/Onboarding-videos.rst @@ -10,46 +10,46 @@ collaboration practices needed to begin working with the model. Users will learn how to do the following: - - Install and run RuFaS - - Contribute through github - - Build and troubleshoot simulations - - Navigate the codebase - - Basic troubleshooting +- Install and run RuFaS +- Contribute through github +- Build and troubleshoot simulations +- Navigate the codebase +- Basic troubleshooting Series Videos ^^^^^^^^^^^^^ 1. `Onboarding Introduction `_ - This introductory video provides a high-level overview of the tools and - technologies needed to begin working with RuFaS. It also explains the - basics of open-source collaboration and github, and shows where to access - the RuFaS repository. +This introductory video provides a high-level overview of the tools and +technologies needed to begin working with RuFaS. It also explains the +basics of open-source collaboration and github, and shows where to access +the RuFaS repository. 2. `Guide to Pyton, IDEs, GitHub, and RuFaS `_ - This video walks through setting up your workstation to run RuFaS by introducing - the key tools and explaining how they support working with the model. It - demonstrates how to install the programs on MacOS and Windows, setting up a - virtual environment, install RuFaS, and run a test to confirm everything is - working correctly. +This video walks through setting up your workstation to run RuFaS by introducing +the key tools and explaining how they support working with the model. It +demonstrates how to install the programs on MacOS and Windows, setting up a +virtual environment, install RuFaS, and run a test to confirm everything is +working correctly. 3. `GitHub Tour, Communication Guidelines, and Pull Requests `_ - This video introduces how RuFaS uses github for collaboration, including where - to find support, documentation, and project information. It walks through - RuFaS communication guidelines and the pull request process. +This video introduces how RuFaS uses github for collaboration, including where +to find support, documentation, and project information. It walks through +RuFaS communication guidelines and the pull request process. 4. `End to End Simulation and Data Visualization `_ - This video walks through how to run a RuFaS simulation by creating biophysical - input files, linking metadata and file paths, and setting up output filters to - examine results. It also guides users through completing a full practice - scenario, troubleshooting common eras and warnings, and exploring options for - customizing solutions. +This video walks through how to run a RuFaS simulation by creating biophysical +input files, linking metadata and file paths, and setting up output filters to +examine results. It also guides users through completing a full practice +scenario, troubleshooting common eras and warnings, and exploring options for +customizing solutions. 5. `RuFaS Deeper Dive `_ - This video provides a deeper look at the RuFaS code, beginning with a core - simulation structure and how to find something specific in the code. It also - shows how inputs and outputs are connected and demonstrates debugging basics. \ No newline at end of file +This video provides a deeper look at the RuFaS code, beginning with a core +simulation structure and how to find something specific in the code. It also +shows how inputs and outputs are connected and demonstrates debugging basics. From becff279b354105c2f6b84ff807b1dc7d44d3917 Mon Sep 17 00:00:00 2001 From: LisaM-kiwi Date: Fri, 20 Mar 2026 12:20:39 -0400 Subject: [PATCH 4/7] edits to files --- docs/_src/_wiki/Onboarding-videos.rst | 44 +++++++++++++-------------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/docs/_src/_wiki/Onboarding-videos.rst b/docs/_src/_wiki/Onboarding-videos.rst index fea9c35a81..9cf2c89a72 100644 --- a/docs/_src/_wiki/Onboarding-videos.rst +++ b/docs/_src/_wiki/Onboarding-videos.rst @@ -11,7 +11,7 @@ collaboration practices needed to begin working with the model. Users will learn how to do the following: - Install and run RuFaS -- Contribute through github +- Contribute through GitHub - Build and troubleshoot simulations - Navigate the codebase - Basic troubleshooting @@ -21,35 +21,35 @@ Series Videos 1. `Onboarding Introduction `_ -This introductory video provides a high-level overview of the tools and -technologies needed to begin working with RuFaS. It also explains the -basics of open-source collaboration and github, and shows where to access -the RuFaS repository. + This introductory video provides a high-level overview of the tools and + technologies needed to begin working with RuFaS. It also explains the + basics of open-source collaboration and github, and shows where to access + the RuFaS repository. -2. `Guide to Pyton, IDEs, GitHub, and RuFaS `_ +2. `Guide to Python, IDEs, GitHub, and RuFaS `_ -This video walks through setting up your workstation to run RuFaS by introducing -the key tools and explaining how they support working with the model. It -demonstrates how to install the programs on MacOS and Windows, setting up a -virtual environment, install RuFaS, and run a test to confirm everything is -working correctly. + This video walks through setting up your workstation to run RuFaS by introducing + the key tools and explaining how they support working with the model. It + demonstrates how to install the programs on MacOS and Windows, set up a + virtual environment, install RuFaS, and run a test to confirm everything is + working correctly. 3. `GitHub Tour, Communication Guidelines, and Pull Requests `_ -This video introduces how RuFaS uses github for collaboration, including where -to find support, documentation, and project information. It walks through -RuFaS communication guidelines and the pull request process. + This video introduces how RuFaS uses github for collaboration, including where + to find support, documentation, and project information. It walks through + RuFaS communication guidelines and the pull request process. 4. `End to End Simulation and Data Visualization `_ -This video walks through how to run a RuFaS simulation by creating biophysical -input files, linking metadata and file paths, and setting up output filters to -examine results. It also guides users through completing a full practice -scenario, troubleshooting common eras and warnings, and exploring options for -customizing solutions. + This video walks through how to run a RuFaS simulation by creating biophysical + input files, linking metadata and file paths, and setting up output filters to + examine results. It also guides users through completing a full practice + scenario, troubleshooting common eras and warnings, and exploring options for + customizing solutions. 5. `RuFaS Deeper Dive `_ -This video provides a deeper look at the RuFaS code, beginning with a core -simulation structure and how to find something specific in the code. It also -shows how inputs and outputs are connected and demonstrates debugging basics. + This video provides a deeper look at the RuFaS code, beginning with a core + simulation structure and how to find something specific in the code. It also + shows how inputs and outputs are connected and demonstrates debugging basics. \ No newline at end of file From 718f6be3feacfc130513a8339b4435dac3eda997 Mon Sep 17 00:00:00 2001 From: LisaM-kiwi Date: Fri, 20 Mar 2026 12:20:51 -0400 Subject: [PATCH 5/7] edited files --- docs/_src/_wiki/onboarding.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_src/_wiki/onboarding.rst b/docs/_src/_wiki/onboarding.rst index 12cde4ec74..1ed57c3035 100644 --- a/docs/_src/_wiki/onboarding.rst +++ b/docs/_src/_wiki/onboarding.rst @@ -930,7 +930,7 @@ Additional Materials -------------------- - Now that you’re familiar with the basics, we encourage you to review - the full `onboarding video series `__ + the `onboarding video series `__ for more details. - If using VS Code or PyCharm and unsure of how to proceed with setting From 32058994d559a26fe23901c823a50a8eab9ee72c Mon Sep 17 00:00:00 2001 From: LisaM-kiwi Date: Fri, 20 Mar 2026 12:33:42 -0400 Subject: [PATCH 6/7] Update Onboarding-videos.rst --- docs/_src/_wiki/Onboarding-videos.rst | 40 +++++++++++++-------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/docs/_src/_wiki/Onboarding-videos.rst b/docs/_src/_wiki/Onboarding-videos.rst index 9cf2c89a72..4713c02541 100644 --- a/docs/_src/_wiki/Onboarding-videos.rst +++ b/docs/_src/_wiki/Onboarding-videos.rst @@ -21,35 +21,35 @@ Series Videos 1. `Onboarding Introduction `_ - This introductory video provides a high-level overview of the tools and - technologies needed to begin working with RuFaS. It also explains the - basics of open-source collaboration and github, and shows where to access - the RuFaS repository. + This introductory video provides a high-level overview of the tools and + technologies needed to begin working with RuFaS. It also explains the + basics of open-source collaboration and github, and shows where to access + the RuFaS repository. 2. `Guide to Python, IDEs, GitHub, and RuFaS `_ - This video walks through setting up your workstation to run RuFaS by introducing - the key tools and explaining how they support working with the model. It - demonstrates how to install the programs on MacOS and Windows, set up a - virtual environment, install RuFaS, and run a test to confirm everything is - working correctly. + This video walks through setting up your workstation to run RuFaS by introducing + the key tools and explaining how they support working with the model. It + demonstrates how to install the programs on MacOS and Windows, set up a + virtual environment, install RuFaS, and run a test to confirm everything is + working correctly. 3. `GitHub Tour, Communication Guidelines, and Pull Requests `_ - This video introduces how RuFaS uses github for collaboration, including where - to find support, documentation, and project information. It walks through - RuFaS communication guidelines and the pull request process. + This video introduces how RuFaS uses github for collaboration, including where + to find support, documentation, and project information. It walks through + RuFaS communication guidelines and the pull request process. 4. `End to End Simulation and Data Visualization `_ - This video walks through how to run a RuFaS simulation by creating biophysical - input files, linking metadata and file paths, and setting up output filters to - examine results. It also guides users through completing a full practice - scenario, troubleshooting common eras and warnings, and exploring options for - customizing solutions. + This video walks through how to run a RuFaS simulation by creating biophysical + input files, linking metadata and file paths, and setting up output filters to + examine results. It also guides users through completing a full practice + scenario, troubleshooting common eras and warnings, and exploring options for + customizing solutions. 5. `RuFaS Deeper Dive `_ - This video provides a deeper look at the RuFaS code, beginning with a core - simulation structure and how to find something specific in the code. It also - shows how inputs and outputs are connected and demonstrates debugging basics. \ No newline at end of file + This video provides a deeper look at the RuFaS code, beginning with a core + simulation structure and how to find something specific in the code. It also + shows how inputs and outputs are connected and demonstrates debugging basics. From d07046d8880278a132281f5cc965719678d26e73 Mon Sep 17 00:00:00 2001 From: LisaM-kiwi Date: Fri, 20 Mar 2026 14:17:14 -0400 Subject: [PATCH 7/7] Update changelog.md --- changelog.md | 1 + 1 file changed, 1 insertion(+) diff --git a/changelog.md b/changelog.md index 9ff0f75f49..a2ec4b10fd 100644 --- a/changelog.md +++ b/changelog.md @@ -48,6 +48,7 @@ v1.0.0 - [2866](https://github.com/RuminantFarmSystems/MASM/pull/2866) - [minor change] [NoInputChange] [NoOutputChange] Clears all mypy errors in test_field_manager.py. - [2863](https://github.com/RuminantFarmSystems/MASM/pull/2863) - [minor change] [NoInputChange] [NoOutputChange] Updates TaskManager to avoid using multiprocessing when running single tasks. - [2854](https://github.com/RuminantFarmSystems/MASM/pull/2854) - [minor change] [NoInputChange] [NoOutputChange] Update `emissions.py` filtering process and remove `use_filter_key_name` option in the OM filter. +- [2872](https://github.com/RuminantFarmSystems/RuFaS/pull/2872) - [minor change] [NoInputChange] [NoOutputChange] Adds information and links for onboarding videos. ### v1.0.0