From 3d3f1a99c43715156b34f85d4ab644943f1b1edd Mon Sep 17 00:00:00 2001 From: JoelLucaAdams Date: Thu, 24 Oct 2024 12:19:31 +0100 Subject: [PATCH] Fix long comments in README --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7849959..4d6e69f 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,8 @@ import pathlib import epyscan import epydeck -# Define the parameter space to be sampled. Here, we are varying the intensity and density. +# Define the parameter space to be sampled. Here, we are varying the intensity +# and density parameters = { # Intensity varies logarithmically between 1.0e22 and 1.0e24 "constant:intens": {"min": 1.0e22, "max": 1.0e24, "log": True}, @@ -34,16 +35,20 @@ parameters = { with open("template_deck_filename") as f: deck = epydeck.load(f) -# Create a grid scan object that will generate 4 different sets of parameters within the specified ranges +# Create a grid scan object that will generate 4 different sets of parameters +# within the specified ranges grid_scan = epyscan.GridScan(parameters, n_samples=4) -# Define the root directory where the simulation folders will be saved. This directory will be created if it doesn't exist. +# Define the root directory where the simulation folders will be saved. +# This directory will be created if it doesn't exist run_root = pathlib.Path("example_campaign") -# Initialize a campaign object with the template deck and the root directory. This will manage the creation of simulation cases. +# Initialize a campaign object with the template deck and the root directory. +# This will manage the creation of simulation cases campaign = epyscan.Campaign(deck, run_root) -# Generate the folders and deck files for each set of parameters in the grid scan +# Generate the folders and deck files for each set of parameters in the +# grid scan paths = [campaign.setup_case(sample) for sample in grid_scan] # Save the paths of the generated simulation folders to a file