Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update docs- mostly adding quickstart #29

Merged
merged 8 commits into from
Jun 26, 2024
Merged

Update docs- mostly adding quickstart #29

merged 8 commits into from
Jun 26, 2024

Conversation

connor-french
Copy link
Owner

Summary

This PR fleshes out the README with installation details, rearranges the documentation front page, adds a quickstart section, and fixes a few things that came up when writing the documentation. Notably, I added a simulation module so users don't have to import msprime separately. It doesn't add functionality, just creates a couple spaceprime functions.

Related Issues

Fixes #8 #7 #28

Changes Made

  • Fleshed out the README
  • Added a Quickstart
  • Added a simulation module, which thinly wraps the msprime sim_ancestry and sim_mutations functions
  • Fixed a plotting issue

Motivation and Context

Adds more detailed documentation and fixed a few issues that came up while working on the documentation.

How Has This Been Tested?

No tests for the documentation. Just rendered the docs and made sure they worked.

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@connor-french connor-french self-assigned this Jun 26, 2024
@connor-french connor-french merged commit 6aae605 into main Jun 26, 2024
7 of 8 checks passed
@connor-french connor-french deleted the docs branch June 26, 2024 19:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant