Skip to main content

Phantom config files: parse, convert, modify, and generate.

Project description

Phantom config

Phantom config files: parse, convert, modify, and generate.

phantom-config can read Phantom .in and .setup files. (They have the same format.) You can, for example:

  • modify config values or comment strings,
  • add new variables or delete old ones,
  • write the config to a JSON or TOML file,
  • generate a config file from a dictionary.

Build Status Coverage Status PyPI

Installation

Install phantom-config with pip

pip install phantomconfig

Usage

Basic usage

Import phantom-config.

>>> import phantomconfig

To read in a Phantom config file

>>> input_file = phantomconfig.read_config('prefix.in')

Print a summary

>>> input_file.summary()

The variables, with their values, comment string, and the block they are a member of, are stored in a dictionary accessed by the .config method.

>>> dtmax = input_file.config['dtmax']

The keys of this dictionary correspond to the variable name, and values are a ConfigVariable named tuple with the variable name, value, comment, and block.

>>> dtmax.name
>>> dtmax.value
>>> dtmax.comment
>>> dtmax.block

You can just get the value if you want.

input_file.get_value('dtmax')

If you like, you can write the Phantom config as a JSON file, and you can read the JSON file.

>>> input_file.write_json('prefix-in.json')
>>> json_file = phantomconfig.read_json('prefix-in.json')

Check that the configs are equal

>>> input_file.config == json_file.config

You can also read and write TOML files.

>>> input_file.write_toml('prefix-in.toml')
>>> toml_file = phantomconfig.read_toml('prefix-in.toml')

You can add a new variable, remove a variable, and change the value of a variable.

# Add new variable
>>> input_file.add_variable(
... 'new_var',
... 12345678,
... comment='Sets thing',
... block='options controlling things',
... )

# Remove a variable
>>> input_file.remove_variable('dtmax')

# Change the value of a variable
>>> input_file.change_value('dumpfile', 'new_dumpfile_name')

Then you can write the Phantom config file with the modified values.

>>> input_file.write_phantom('new.in')

Examples

Generate a config from a dictionary

You can create a Phantom .setup file from a Python dictionary. First create the dictionary

>>> setup = {}
>>> setup['gas properties'] = {
... 'cs': (cs, 'sound speed'),
... 'npart': (npart, 'number of particles in x direction'),
... 'rhozero': (rhozero, 'initial density'),
... 'ilattice': (ilattice, 'lattice type'),
... }

Then you can read the dictionary with phantomconfig, and write to a Phantom .setup file

>>> setup_config = phantomconfig.read_dict(setup)
>>> setup_config.header = [
...     'input file for some particular setup routine',
...     'short description of what it does']
... ]
>>> setup_config.write_phantom('filename.setup')

This writes a file like

# input file for some particular setup routine
# short description of what it does

# gas properties
                  cs =        1.000   ! sound speed
               npart =         9999   ! number of particles in x direction
             rhozero =        0.100   ! initial density
            ilattice =            2   ! lattice type

Writing multiple configs

Say you want to write multiple configs, each with a different parameter value. For example, you have a template .in file and you want to vary the alpha parameter. The following

  1. reads the template file
  2. loops over a list of alpha values, writing a new .in file for each value in the list
alphas = [0.1, 0.2, 0.3]
infile = phantomconfig.read_config('template.in')

for alpha in alphas:
    infile.change_value('alpha', alpha)
    infile.write_phantom(f'alpha={alpha}.in')

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for phantomconfig, version 0.3.2
Filename, size File type Python version Upload date Hashes
Filename, size phantomconfig-0.3.2-py3-none-any.whl (10.8 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size phantomconfig-0.3.2.tar.gz (11.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page