Skip to content

Commit dae76ee

Browse files
foxBMSfoxBMS
committed
Minor bug fixes and performance improvements
1 parent d558f7a commit dae76ee

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

54 files changed

+247
-199
lines changed

‎.vscode/cspell.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,10 +30,12 @@
3030
"IISB",
3131
// rst and sphinx
3232
"automodule",
33+
"genindex",
3334
"graphviz",
3435
"imgmath",
3536
"literalinclude",
3637
"maxdepth",
38+
"modindex",
3739
"programoutput",
3840
"sphinxcontrib",
3941
"toctree",
@@ -56,7 +58,6 @@
5658
"pylint",
5759
"pytest",
5860
"scipy",
59-
"seaborn",
6061
"sphinx",
6162
"jsonschema",
6263
"tox",

‎.vscode/launch.json‎

Lines changed: 22 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -5,43 +5,48 @@
55
"version": "0.2.0",
66
"configurations": [
77
{
8-
"name": "Python: BASD Battery System Designer Tool.",
8+
"name": "Python: BASD Battery System Designer Tool (design).",
99
"type": "python",
1010
"request": "launch",
1111
"module": "basd",
1212
"cwd": "${workspaceRoot}/src",
1313
"args": [
14-
"-r",
15-
"${workspaceRoot}/tests/system-requirements.json",
16-
"-p",
17-
"${workspaceRoot}/tests/profiles",
18-
"-d",
19-
"${workspaceRoot}/tests/data",
14+
"design",
15+
"--requirements",
16+
"${workspaceRoot}/tests/requirements/Example-Requirements.json",
17+
"--database",
18+
"${workspaceRoot}/tests/cells",
2019
"--report",
21-
"${workspaceRoot}",
20+
"${workspaceRoot}/src/report",
2221
]
2322
},
2423
{
25-
"name": "Python: BASD Report Vizualization Tool (rviz).",
24+
"name": "Python: BASD CAD Vizualization Tool (cad)",
2625
"type": "python",
2726
"request": "launch",
28-
"module": "basd.rviz",
27+
"module": "basd",
2928
"cwd": "${workspaceRoot}/src",
3029
"args": [
31-
"-r",
32-
"${workspaceRoot}/src/report.csv"
30+
"cad",
31+
"--database",
32+
"${workspaceRoot}/tests/cells",
33+
"--output-format",
34+
"stl",
35+
"--report",
36+
"${workspaceRoot}/src/report.json",
37+
"0"
3338
]
3439
},
3540
{
36-
"name": "Python: BASD CAD Vizualization Tool (cad)",
41+
"name": "Python: BASD CAD Vizualization Tool (db)",
3742
"type": "python",
3843
"request": "launch",
39-
"module": "basd.cad",
44+
"module": "basd",
4045
"cwd": "${workspaceRoot}/src",
4146
"args": [
42-
"--interactive",
43-
"--layout",
44-
"${workspaceRoot}/tests/system-layout.json"
47+
"db",
48+
"add",
49+
"${workspaceRoot}/tests/cells"
4550
]
4651
}
4752
]

‎.vscode/settings.json‎

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,25 @@
2828
"editor.rulers": [
2929
88
3030
],
31+
"editor.defaultFormatter": "ms-python.black-formatter",
32+
"editor.formatOnSave": true,
3133
},
34+
"black-formatter.args": [
35+
"--config",
36+
"pyproject.toml",
37+
"."
38+
],
39+
"isort.args": [
40+
"--profile",
41+
"black",
42+
"--settings-file",
43+
"pyproject.toml",
44+
"."
45+
],
46+
"pylint.args": [
47+
"--rcfile",
48+
"pyproject.toml"
49+
],
3250
"[yaml]": {
3351
"editor.rulers": [],
3452
},
@@ -42,23 +60,5 @@
4260
"python.analysis.extraPaths": [
4361
"src/basd",
4462
"src"
45-
],
46-
"python.linting.enabled": true,
47-
"python.linting.pylintEnabled": true,
48-
"python.linting.lintOnSave": true,
49-
"python.formatting.provider": "none",
50-
"python.formatting.blackArgs": [
51-
"--config",
52-
"pyproject.toml",
53-
"."
54-
],
55-
"isort.args": [
56-
"--settings-file",
57-
"pyproject.toml",
58-
"."
59-
],
60-
"pylint.args": [
61-
"--rcfile",
62-
"pyproject.toml"
6363
]
6464
}

‎LICENSE‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
BSD 3-Clause License (BSD 3-Clause "New" or "Revised" License)
22

3-
Copyright (c) 2010 - 2023, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V.
3+
Copyright (c) 2010 - 2024, Fraunhofer-Gesellschaft zur Foerderung der angewandten Forschung e.V.
44
All rights reserved.
55

66
Redistribution and use in source and binary forms, with or without

‎README.md‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@
77
</tbody>
88
</table>
99

10-
Automated, requirements driven battery system design
10+
```text
11+
Automated, requirements driven battery system design
12+
```
1113

1214
``BaSD`` uses the basic, formalized requirements for a battery system from an
1315
electrical point of view (e.g., minimum and maximum system voltage, maximum
@@ -27,13 +29,13 @@ configuration, layout and simplified CAD model
2729
The latest release can be installed via pip from [PyPi](https://pypi.org/project/basd):
2830

2931
```bash
30-
$ pip install basd
32+
pip install basd
3133
```
3234

3335
The latest development version can be installed via pip:
3436

3537
```bash
36-
$ pip install git+https://github.com/BaSD-Project/BaSD
38+
pip install git+https://github.com/foxBMS/BaSD
3739
```
3840

3941
## Acknowledgment

‎docs/Makefile‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
SPHINXOPTS = -W
22
SPHINXBUILD = python -m sphinx
33
SPHINXPROJ = battery_system_designer
4-
SOURCEDIR = .
5-
BUILDDIR = _build
4+
SOURCEDIR = $(dir $(realpath $(lastword $(MAKEFILE_LIST))))
5+
BUILDDIR = $(dir $(realpath $(lastword $(MAKEFILE_LIST))))/../build/doc
66

77
# Put it first so that "make" without argument is like "make help".
88
help:

‎docs/conf.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828

2929
project = "Battery System Designer"
3030
copyright = (
31-
"2010 - 2023, Fraunhofer-Gesellschaft zur Foerderung der angewandten "
31+
"2010 - 2024, Fraunhofer-Gesellschaft zur Foerderung der angewandten "
3232
"Forschung e.V. All rights reserved. See license section for further "
3333
"information."
3434
)
@@ -50,7 +50,7 @@
5050
"footer_icons": [
5151
{
5252
"name": "GitHub",
53-
"url": "https://github.com/BaSD-Project/BaSD",
53+
"url": "https://github.com/foxBMS/BaSD",
5454
"html": """
5555
<svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 16 16">
5656
<path fill-rule="evenodd" d="M8 0C3.58 0 0 3.58 0 8c0 3.54 2.29 6.53 5.47 7.59.4.07.55-.17.55-.38 0-.19-.01-.82-.01-1.49-2.01.37-2.53-.49-2.69-.94-.09-.23-.48-.94-.82-1.13-.28-.15-.68-.52-.01-.53.63-.01 1.08.58 1.23.82.72 1.21 1.87.87 2.33.66.07-.52.28-.87.51-1.07-1.78-.2-3.64-.89-3.64-3.95 0-.87.31-1.59.82-2.15-.08-.2-.36-1.02.08-2.12 0 0 .67-.21 2.2.82.64-.18 1.32-.27 2-.27.68 0 1.36.09 2 .27 1.53-1.04 2.2-.82 2.2-.82.44 1.1.16 1.92.08 2.12.51.56.82 1.27.82 2.15 0 3.07-1.87 3.75-3.65 3.95.29.25.54.73.54 1.48 0 1.07-.01 1.93-.01 2.2 0 .21.15.46.55.38A8.013 8.013 0 0 0 16 8c0-4.42-3.58-8-8-8z"></path>
@@ -59,7 +59,7 @@
5959
"class": "",
6060
},
6161
],
62-
"source_repository": "https://github.com/BaSD-Project/BaSD/",
62+
"source_repository": "https://github.com/foxBMS/BaSD/",
6363
"source_branch": "master",
6464
}
6565
source_suffix = ".rst"

‎docs/development/changelog.rst‎

Lines changed: 33 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,40 @@ Changelog
33

44
All notable changes to this project will be documented in this file.
55

6-
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
7-
and this project adheres to [Calendar Versioning](https://calver.org/).
6+
The format is based on
7+
`Keep a Changelog <https://keepachangelog.com/en/1.0.0/>`_,
8+
and this project adheres to `Calendar Versioning <https://calver.org/>`_.
9+
10+
[2024.01.1] 2024-01-22
11+
----------------------
12+
13+
Changed
14+
^^^^^^^
15+
16+
- In case a battery cannot be installed from an xml-file, do not raise an
17+
error, instead issue a warning.
18+
- The implementation of system design process is now facilitation multiple
19+
cores to speed up the design process.
20+
This is particularly useful when hundreds or more of cells are considered.
21+
The default number of cores is `<available_cores> - 1`.
22+
- Removed unused imports.
23+
24+
Fixed
25+
^^^^^
26+
27+
- Fixed a bug in `BasicParameterSet` implementation that showed up in Python
28+
3.11.
29+
- Minor documentation fixes.
30+
- Developer experience:
31+
32+
- Updated VS Code settings for latest VS Code releases.
33+
- Fixed VS Code launcher configurations.
34+
35+
- Fix documentation build via Makefile.
36+
- Fixed project links.
837

938
[2023.09.1] 2023-09-05
10-
-----------------------
39+
----------------------
1140

1241
Fixed
1342
^^^^^
@@ -16,7 +45,7 @@ Fixed
1645
- Changelog layout.
1746

1847
[2023.09.0] 2023-09-05
19-
-----------------------
48+
----------------------
2049

2150
Fixed
2251
^^^^^

‎docs/development/dev-installation.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ For Development
2323
$ conda create -y -n basd-devel-env-11 python=3.10 pip
2424
$ conda activate basd-devel-env-11
2525
$ python -m pip install flit --upgrade
26-
$ git clone https://github.com/BaSD-Project/BaSD
26+
$ git clone https://github.com/foxBMS/BaSD
2727
$ cd battery-system-designer
2828
$ python -m flit install --deps all --only-deps
2929
@@ -36,4 +36,4 @@ For Development
3636
$ cd path/to/repo
3737
$ code .
3838
$ cd src # testing needs to be run in source directory
39-
$ python -m basd design -r ../tests/requirements/dummy-system.json
39+
$ python -m basd design -r ../tests/requirements/Example-system.json --database ../tests/cells

‎docs/index.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ Battery System Designer (``BaSD``)
55

66
Automated, requirements driven battery system design
77

8-
The Battery System Designer (``BaSD``) tool is tool to support the design,
9-
layout and optimization the development of battery systems.
8+
The Battery System Designer (``BaSD``) tool is tool to support the design
9+
process, layout and optimization of battery systems during development.
1010

1111
``BaSD`` uses the basic, formalized requirements for a battery system from an
1212
electrical point of view (e.g., minimum and maximum system voltage, maximum

0 commit comments

Comments
 (0)