search

rzshrote / pybrops

Python Breeding Optimizer and Simulator: A Python library for simulating and optimizing breeding pipelines.
https://rzshrote.github.io/pybrops/
MIT License
2 stars 1 forks source link

Looking for documentation / API #79

Closed mika-okamoto closed 7 months ago

mika-okamoto commented 1 year ago

Hello, I am a researcher in Dr. Abraham Palmer’s lab at UC San Diego. I am looking into ways to simulate breeding algorithms to compare how various algorithms retain genetic diversity across generations, and came across your paper. Can you please point me in the right direction for how to run PyBrOpS after installation to simulate breeding across consecutive generations? Any documentation or API or guidance you can provide would be extremely helpful.

Thank you for any help you can provide, and thanks for your excellent science! Best, Mika

rzshrote commented 1 year ago

Hi Mika,

Apologies for the delayed reply. Field season has been very busy and I haven't had the time to code. I am currently working on building a website to host all the documentation and improving several aspects of the software as requested by reviewers. The ongoing work can be viewed on the "arch_with_pymoo" branch and contains several examples within the "examples" directory. I hope to finish the website, merge to the main branch, and release to the public within the next 1-2 months.

If you're looking into simulation packages, I also recommend you look into AlphaSimR (if you haven't already found it). This package is also popular and has better documentation that what PyBrOpS currently has at the moment.

Best regards, Robert

rzshrote commented 7 months ago

Documentation has been generated and is available at the GitHub Pages website.