Skip to content

Commit 528484e

Browse files
committed
Assorted minor fixes
1 parent 62b6f01 commit 528484e

6 files changed

Lines changed: 24 additions & 8 deletions

File tree

doc/developers_guide.txt

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,17 +40,18 @@ should fork the main `Sumatra repository on Github`_, then clone your own fork.:
4040

4141
$ cd /some/directory
4242
$ git clone https://github.com/<username>/sumatra.git
43+
$ cd sumatra
4344

4445
Now you need to make sure that the ``sumatra`` package is on your PYTHONPATH and
4546
that the ``smt`` and ``smtweb`` scripts are on your PATH. You can do this either
46-
by installing Sumatra normally::
47+
by installing Sumatra normally from the local checkout::
4748

48-
$ pip install ./sumatra
49+
$ pip install .[dev]
4950

5051
(if you do this, you will have to re-run ``pip install`` any time you make
5152
changes to the code) *or* using the "editable" option::
5253

53-
$ pip install --editable ./sumatra
54+
$ pip install --editable .[dev]
5455

5556
To ensure you always have access to the most recent version, add the main repository as "upstream"::
5657

doc/parameter_files.txt

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,20 @@ If the name of your parameter file ends in a recognized extension, such as
1414
".json" or ".yaml", Sumatra will use the associated format, otherwise it
1515
chooses the appropriate format based on file contents.
1616

17+
18+
Enabling and disabling parameter file parsing
19+
=============================================
20+
21+
By default, Sumatra will try to parse your parameter files.
22+
You can turn this off with::
23+
24+
$ smt configure --ignore-parameters
25+
26+
To re-enable parsing::
27+
28+
$ smt configure --parse-parameters
29+
30+
1731
Supported formats
1832
=================
1933

@@ -84,6 +98,7 @@ sub-parameter sets to be included from other files. Example::
8498
}
8599
}
86100

101+
87102
Adding new formats
88103
==================
89104

doc/releases/0.8.0.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Sumatra 0.8.0 release notes
33
===========================
44

5-
*17th April 2025*
5+
*18th April 2025*
66

77
It is almost ten years since the last release of Sumatra!
88

pyproject.toml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,9 +95,10 @@ test = [
9595
]
9696

9797
dev = [
98-
"sumatra[web,git,hg,remote,postgres,latex,mpi,docs,test]",
98+
"sumatra[web,git,hg,remote,postgres,mysql,latex,mpi,docs,test]",
9999
"build",
100-
"twine"
100+
"twine",
101+
"docker"
101102
]
102103

103104
[tool.black]

sumatra/commands.py

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -333,7 +333,6 @@ def configure(argv):
333333
project.allow_command_line_parameters = not args.plain
334334
if args.ignore_parameters is not None:
335335
project.ignore_parameters = args.ignore_parameters
336-
print("Setting ignore parameters to {}".format(args.ignore_parameters))
337336
if args.add_plugin:
338337
project.load_plugins(args.add_plugin)
339338
if args.remove_plugin:

sumatra/parameters.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ def parse_command_line_parameter(self, p):
7070
Uses ParameterSet format-specific type parsers stored in self.casts
7171
7272
Raises ValueError with args tuple containing name, value if parameter name
73-
isn't in self.values.
73+
isn't in self._values.
7474
"""
7575
pos = p.find('=')
7676
if pos == -1:

0 commit comments

Comments
 (0)