This tutorial demonstrates all available step-by-step styling features. Use this as a reference when creating your own tutorials.

Introduction Section

Example: Building Your First Project

What you'll learn: How to structure and organize a project with best practices
Time required: About 10 minutes
Prerequisites: Basic familiarity with command line

Basic Procedural Steps

Steps are displayed with numbered circles, vertical connectors, and clear organization:

1

Set Up Your Environment

First, create a dedicated directory and initialize version control:

mkdir my-project
cd my-project
git init
Why version control?

Git helps you track changes and collaborate with others.

2

Install Dependencies

Install the required packages in your environment:

pip install asimov bilby-pipe
Virtual environments

Consider using a virtual environment to avoid conflicts with other projects.

3

Verify Installation

Check that everything is installed correctly:

asimov --version
bilby --version
Check output

If you see "command not found," the installation didn't complete. Reinstall the packages.

Multiple Options

When a step has alternatives, present them as options:

Option A: Interactive Setup (Recommended for beginners)

Use the guided wizard to configure your project step by step:

asimov setup --interactive

This walks you through each configuration choice with helpful explanations.

Option B: Configuration File (For advanced users)

Create a configuration file with all settings upfront:

cat > config.yml << EOF
name: my-project
pipeline: bilby
events:
  - GW150914
EOF
asimov setup -c config.yml

This is faster if you know exactly what you want.

Step Callouts

Use callouts to highlight important information:

Information Note

Additional context

This note provides helpful context that isn't essential to complete the step, but will make your experience better.

Warning

Potential issue

Pay attention here—this action could cause problems if not done correctly.

Tip

Pro tip

This will make your workflow more efficient or help you avoid common mistakes.

Important

Required step

You must complete this action for the tutorial to work correctly.

Substeps Within a Step

For complex steps, break them down with substeps:

1

Configure Your Analysis

The configuration process involves several substeps:

1. Select Your Pipeline

Choose which analysis pipeline you want to use. Options include bilby, PyCBC, or LALInference.

asimov setup
> Which pipeline? [bilby/pycbc/lal]: bilby
2. Configure Event Data

Specify which gravitational wave events you want to analyze:

> Events to analyze: GW150914 GW151226
3. Set Analysis Parameters

Configure the details of your analysis:

> Duration (seconds): 4
> Sample rate (Hz): 2048
> Prior type: [uniform/bilby-default]: bilby-default

Combining Callouts and Code

You can mix callouts with code examples:

1

Submit Your First Job

Once everything is configured, submit your analysis:

asimov manage build
asimov manage submit
What just happened?

build generated configuration files for your pipeline. submit sent them to the scheduler.

Check status

Use asimov monitor to watch your job progress in real time.

Wait for completion

Analyses can take hours. Don't close your terminal or shut down the monitoring process prematurely.

Summary

The new tutorial styling provides:

  • Numbered steps with visual circles and connecting lines for clear flow
  • Multiple callout types (notes, warnings, tips, important) with emoji indicators
  • Option containers for presenting alternatives side-by-side
  • Substeps for breaking down complex procedures
  • Consistent spacing and colors that match the site’s design

For detailed implementation instructions, see Tutorial Styling Guide.