Open source code repository
All code is freely available at https://github.com/harrispopgen/mushi
Developer tools
Developer install:
make install
You will also need to install Pandoc to build docs and run doctests.
Run tests:
make test
Format code:
make format
Lint:
make lint
Build docs locally (you can then see the generated documentation in docs/_build/html/index.html
):
make docs
Docs are automatically deployed to github pages via a workflow on push to the master branch.
Test notebook
A test notebook that simulates under the linkage-free forward model (where the PRF composite likelihood is not approximate): notebooks/simulation.ipynb
Note that this notebook is used to build a docs page.
Todo list
Todo
document CLI
(The original entry is located in /home/runner/work/mushi/mushi/docs/index.rst, line 43.)
Todo
setup Conda install
(The original entry is located in /home/runner/work/mushi/mushi/docs/install.rst, line 17.)