AllenInstitute / AllenInstitute/bmtk

build_env_bionet fails when config_file is not explicitly provided

Open
#162 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
335
Forks
102
Avg merge
1d 5h
Merged PRs (30d)
6

Description

The default value of None for the kwarg config_file to bmtk.utils.sim_setup.build_env_filternet is an invalid one and causes an error, since a string or Path is expected. I suggest only passing config_file to env_builder.build if it is not None, so that env_builder can specify its own correct default.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at bmtk.utils.sim_setup.build_env_filternet and inspect how the optional config_file argument is passed to env_builder.build. Confirm the failure when config_file is omitted, then verify that the build uses env_builder's default without producing the invalid-value error.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
tooling
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.