ALLEN INSTITUTE

# bmtk.utils.create_environment package

## Submodules

## bmtk.utils.create_environment.create_environment module

bmtk.utils.create_environment.create_environment.create_environment(simulator, base_dir='.', network_dir=None, components_dir=None, node_sets_file=None, output_dir=None, overwrite=False, run_script=True, config_file=None, config_name=None, split_configs=False, network_filter=None, report_vars=[], report_nodes=None, spikes_inputs=None, rates_inputs=None, clamp_reports=[], current_clamp=None, file_current_clamp=None, se_voltage_clamp=None, tstart=0.0, tstop=1000.0, dt=None, dL=20.0, spikes_threshold=-15.0, nsteps_block=5000, v_init=-80.0, celsius=34.0, compile_mechanisms=False, use_relative_paths=True, include_examples=False)
  Parameters:

    - simulator

    - base_dir

    - network_dir

    - components_dir

    - node_sets_file

    - output_dir

    - overwrite

    - run_script

    - config_file

    - config_name

    - split_configs

    - network_filter

    - report_vars

    - report_nodes

    - spikes_inputs

    - rates_inputs

    - clamp_reports

    - current_clamp

    - file_current_clamp

    - se_voltage_clamp

    - tstart

    - tstop

    - dt

    - dL

    - spikes_threshold

    - nstesp_block

    - v_init

    - celsius

    - compile_mechanisms

    - use_relative_paths

    - include_examples

## bmtk.utils.create_environment.env_builder module

class bmtk.utils.create_environment.env_builder.BioNetEnvBuilder(base_dir='.', network_dir=None, components_dir=None, output_dir=None, node_sets_file=None)

  Bases: `EnvBuilder`

  property bmtk_simulator
  compile_mechanisms()
  property examples_dir
  property target_simulator

class bmtk.utils.create_environment.env_builder.EnvBuilder(base_dir='.', network_dir=None, components_dir=None, output_dir=None, node_sets_file=None)

  Bases: `object`

  property base_dir
  property bmtk_simulator
  build(include_examples=False, use_relative_paths=True, report_vars=[], report_nodes=None, clamp_reports=[], current_clamp=None, file_current_clamp=None, se_voltage_clamp=None, network_filter=None, spikes_inputs=None, rates_inputs=None, config_file='config.json', overwrite_config=False, config_name='', split_configs=False, run_script=True, **run_args)
  compile_mechanisms()
  property components_dir
  property examples_dir
  property network_dir
  property output_dir
  property scripts_root
  property target_simulator

class bmtk.utils.create_environment.env_builder.FilterNetEnvBuilder(base_dir='.', network_dir=None, components_dir=None, output_dir=None, node_sets_file=None)

  Bases: `EnvBuilder`

  property bmtk_simulator
  property examples_dir
  property target_simulator

class bmtk.utils.create_environment.env_builder.PointNetEnvBuilder(base_dir='.', network_dir=None, components_dir=None, output_dir=None, node_sets_file=None)

  Bases: `EnvBuilder`

  property bmtk_simulator
  property examples_dir
  property target_simulator

class bmtk.utils.create_environment.env_builder.PopNetEnvBuilder(base_dir='.', network_dir=None, components_dir=None, output_dir=None, node_sets_file=None)

  Bases: `EnvBuilder`

  property bmtk_simulator
  property examples_dir
  property target_simulator

## Module contents