Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

---

Expand Down
1 change: 1 addition & 0 deletions changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
55 changes: 55 additions & 0 deletions docs/_src/_wiki/Onboarding-videos.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
Onboarding Videos
=================

Introduction
~~~~~~~~~~~~

The `onboarding video series <https://www.youtube.com/playlist?list=PLqq6i4QOoueR-a2mxVX3Gc78s1wvTRfr1>`_
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 <https://www.youtube.com/watch?v=6RbJs0iZmgo&list=PLqq6i4QOoueR-a2mxVX3Gc78s1wvTRfr1&index=1&t=1s>`_

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 <https://www.youtube.com/watch?v=15sfDK986FQ&list=PLqq6i4QOoueR-a2mxVX3Gc78s1wvTRfr1&index=2>`_

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 <https://www.youtube.com/watch?v=OmDQwiBGA8Y&list=PLqq6i4QOoueR-a2mxVX3Gc78s1wvTRfr1&index=3>`_

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 <https://www.youtube.com/watch?v=opyd3_WUrZU&list=PLqq6i4QOoueR-a2mxVX3Gc78s1wvTRfr1&index=4>`_

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 <https://www.youtube.com/watch?v=f5BWmh8v1Kk&list=PLqq6i4QOoueR-a2mxVX3Gc78s1wvTRfr1&index=5>`_

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.
3 changes: 1 addition & 2 deletions docs/_src/_wiki/onboarding.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://youtu.be/Xqjse-fKQV0>`__
the `onboarding video series <https://www.youtube.com/playlist?list=PLqq6i4QOoueR-a2mxVX3Gc78s1wvTRfr1>`__
for more details.

- If using VS Code or PyCharm and unsure of how to proceed with setting
Expand Down
1 change: 1 addition & 0 deletions docs/_src/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ Navigation
:caption: Getting Started:

_wiki/onboarding
_wiki/Onboarding-videos

.. toctree::
:maxdepth: 2
Expand Down
Loading