Guides

Each guide is one task in your own project, its steps in order, its commands shown with what they print. The home page walks through a whole project first, on a tensile test; a guide goes further on one subject, and the concepts say why SampleKit works as it does.

The guides' examples run in the demo. SampleKit carries the home page's tensile test as a demo in six steps, each a project of its own: a guide's last step is the fourth, with the results, tables, figures and scripts; the fifth holds two projects. samplekit alone opens the start page, where g, then The demo, writes it, with a Python environment for its model, and opens a step. A guide's python scripts/… runs with that environment's Python (the Python to use).

Getting started

Guide

For

Install SampleKit

the command line and the Python package, on Linux, macOS and Windows

Start a project

a folder set up for SampleKit: its configuration, its environment, a first sample

Bring existing data in

measurements in a spreadsheet, CSV files or a notebook, turned into sample files

Write a model

the values your Python formulas compute, and how SampleKit keeps them current

Start from templates

a configuration, a model, a sample and a script to download and fill in

Working with samples

Guide

For

Edit samples

a value measured again, an attribute, a tag, a table's row, a new sample

Find and select samples

which samples, which values, in which order, grouped how, and the table written to a file

Link samples

a sample naming another, a file or a web page: shown, followed both ways, checked, kept when renamed

Work in the terminal interface

the same work from one full-screen view, by the keyboard

Choose the colours

the theme of the terminal interface, the colours of the command line, and files ready for common terminal themes

Work from Python

your samples read, analysed and changed from a script or a notebook

Run a script of the model

a task written once in the model, run on the samples selected

Publishing and sharing

Guide

For

Tables and figures for a paper

a paper's tables and figures, written again by one command, made again as they were

Several projects

series kept apart, read together, what they share declared once

Organise a project's settings

.samplekitrc in several files, each imported where it is needed

Share a project

one project on two computers, or with a colleague, through git or a synchronised folder

Check a project in continuous integration

a job that fails when a file is wrong or a value is not current

When something goes wrong

Guide

For

When something goes wrong

a refusal, a warning, a value you do not trust: what it means, what to do

Upgrade from an older SampleKit

a project written by an earlier version, with the migration tool or by hand