add usage examples

[RamiALBASHA]

Hi RuFaS team,

I'm new to the RuFaS ecosystem and already greately appreciate the neatness of the source code.
In addition to the code and scientific documentation, I think that adding turn-key examples would further enhance user's understanding of the package requirements, functioning, outputs, etc. Could you kindly consider a request to adding such example(s)?

Best,

Rami

[ew3361zh]

Thank you, Rami, we appreciate the kind words. Can you expand on what you mean by turn-key examples here?

• If you're specifically talking about outputs from the model, that's definitely on our radar mentioned in this discussion here - Where are the outputs?? #2548.
• As far as package requirements, they are outlined in the pyproject.toml file.
• And we have a couple of example farm simulations that are available - the default one being the freestall dairy if you run the model without changing any inputs. We also provide an open lots farm which has a larger animal population, different manure handling and processing, etc. Perhaps you're looking for a clearer outline of what the inputs are for those farms?

[RamiALBASHA]

Hi Niko,
Thanks for your answer.
As for the turn-key example, I must admit that I did not follow the “Beginner’s Simulation Worksheet” before posting my request. However, I guess that my proposal still holds.
My understanding from many scientific packages that I have seen, dealt with or developed so far (e.g. APSIM model), is that the core package is isolated from example files. Something like:

examples /
    └── example1/
        └── inputs /
        └── main.py
    └── example2/
        └── inputs /
        └── main.py
source_code_dir (e.g. src)/
    └── …

In such case the “main” scripts in the example point to the entrypoint of the source code, and each example has its own files/folders. This is a rather typical architecture of python packages (as proposed by the official packaging tuto)
As per “requirements”, I referred to input files not package dependencies. Thank you though for your clarification.

[ew3361zh]

Hi Rami, thank you for clarifying.

I'm glad you found the "Beginner's Simulation Worksheet" and hope it was a helpful guide. The two example farm metadata files we currently provide - the freestall and open lot simulations - are designed to give users a solid starting range of manure processing systems, diverse animal herds, crop and soil practices, and feed storage and management strategies.

We are actively working on simplifying the input structure so that users can run and adapt simulations with minimal up-front customization. Your feedback will be valuable as we continue refining the entry points and improving the accessibility of example simulations.

We really appreciate the thoughtful feedback!

Best regards,
Niko