Skip to content

Commit

Permalink
Fix long comments in README
Browse files Browse the repository at this point in the history
  • Loading branch information
JoelLucaAdams committed Oct 24, 2024
1 parent 8eda3ed commit 3d3f1a9
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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},
Expand All @@ -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
Expand Down

0 comments on commit 3d3f1a9

Please sign in to comment.