Skip to content

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

slimmc-examples

Worked examples for slimmc.

This repository is intended for compact, runnable examples that demonstrate model syntax, simulation workflows, and analysis with pyslimmc. Scientific validation and literature reproductions belong in slimmc-case-studies.

Running examples

Tool commands are configured once in config.mk:

SLIMMC ?= slimmc
PYTHON ?= python3

Running make without arguments only displays the available commands.

make

List available examples:

make list

Run all examples:

make all

Remove generated results:

make clean

Run one example:

make 001_styrene_homo

Each numbered directory owns its own small Makefile, where all means check, run, then analyze.

Index

ID Example Description
001 Styrene homopolymerization Basic homo workflow: model validation, simulation, stored result, and pyslimmc inspection.

Directory convention

Every runnable example lives in:

examples/NNN_short_name/
├── README.md
├── Makefile
├── *.model
└── analyze.py

The top-level Makefile discovers only numbered directories matching examples/NNN_*/Makefile. The examples/_template/ directory is therefore not run automatically.

When adding an example:

  1. copy examples/_template/;
  2. rename it to the next NNN_short_name;
  3. make the model and analysis self-contained;
  4. add one row to the index above;
  5. verify make check, make run, and make analyze.

Scope

Examples should teach one main idea clearly. Prefer realistic chemistry and units where practical, but keep examples small enough to run conveniently. For literature-derived validation, parameter fitting, or benchmark reproduction, use the case-studies repository instead.

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages