Introduction
Terms defined: virtual environment
- Sooner or later you're going to want to share your findings
- And learning how the web works is fun
- Use modern Python and JavaScript tools
- Yes, you're going to have to learn some JavaScript…
- …but it's not as bad as you've been told
- All of these materials can be freely re-used under an open license
Setup
- Install uv for managing Python packages and virtual environments and then run:
uv venvin the root directory of this project to create a virtual environment in./.venvsource .venv/bin/activateto activate that virtual environmentuv pip install -r pyproject.tomlto install requirements
- To regenerate the sample data, run
make datasetsto:- install the default parameters for
snailzin./params, and - regenerate the sample data in
./data - We use Make to run tasks because every other option proved to be more complicated
- install the default parameters for
- Project uses McCole to generate and check HTML
- Run
make renderto regenerate the HTML in./docsfrom the Markdown files - Run
make lintat any time to check the state of the project
- Run
The Data
snailz creates synthetic data for a study of mutant snails in the Pacific Northwest.
- One or more surveys are conducted at one or more sites.
- Each survey collects genomes and sizes of snails.
- A grid at each site is marked out to show the presence or absence of pollution.
- Staff perform assays of the snails' genetic material.
- Each assay plate has a design showing the material applied and readings showing the measured response.
- Plates may be invalidated after the fact if a staff member believes it is contaminated.