Skip to content

Commit 4b4aaf6

Browse files
KGergo88KGergo88
authored
Merge pull request #10 from bmwcarit/ISSUE_#5_MemoryManagerRedesign
Issue #5 memory manager redesign
2 parents d220266 + 4a790dc commit 4b4aaf6

File tree

85 files changed

+43415
-34039
lines changed

Some content is hidden

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

85 files changed

+43415
-34039
lines changed

‎.codacy.yml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
3+
# For options see: https://support.codacy.com/hc/en-us/articles/115002130625-Codacy-Configuration-File
4+
5+
duplication:
6+
exclude_paths:
7+
- tests/*

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,3 +16,6 @@ genDoc/call_graph_uml/*
1616
# Exclude PyCharm config files but include inspection profiles
1717
.idea/*
1818
!.idea/inspectionProfiles/
19+
20+
# Exclude the coverate reports
21+
tests/other_files/coverage/reports/*

‎.idea/inspectionProfiles/profiles_settings.xml‎

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.travis.yml‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,14 @@ git:
4242
submodules: false
4343

4444
script:
45-
- tree --charset unicode ../../
45+
- tree -a -I .git ../
4646
- find . -type f -name "*.py" -exec pylint -j 0 --exit-zero {} \;
47-
- python -m unittest test
48-
- pushd ./tests
49-
- coverage run --branch test__cmd-line.py
47+
- cd tests/functional_tests
48+
- python -m unittest -v
49+
- cd ../unit_tests
50+
- coverage run -m unittest -v
5051
- tree -a -I .git ../
51-
- coverage report
52+
- coverage report --omit="/home/travis/virtualenv/*","/home/travis/build/bmwcarit/Emma/tests/*"
5253
- coverage xml
5354

5455
after_success:

‎CONTRIBUTORS‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ N: Full name
77
I: Initials (besides the name initials can be used (alternatively to someones name) to identify someones comments)
88
E: Email address
99
K: PGP key ID and fingerprint
10-
F: Files and directories with globbing patterns patterns
10+
F: Files and directories with globbing patterns
1111
L: Link providing more information about this individual
1212
D: Description
1313
C: Country
@@ -21,7 +21,7 @@ An entry ends with two newlines.
2121
````````````````````
2222
N: Marcel Schmalzl
2323
I: MSc
24-
E: marcel.schmalzl@partner.bmw.de
24+
E: marcel.schmalzl( .at)partner.bmw.de
2525
F: *
2626
D: Emma originator
2727
L: https://github.com/holzkohlengrill/
@@ -38,7 +38,8 @@ C: Germany
3838
````````````````````
3939
N: András Gergő Kocsis
4040
I: AGK
41-
E: kocsisandrasgergo@gmail.com
41+
E: kocsisandrasgergo<AT GMAIL>
4242
F: *
4343
D: Emma maintainer
44+
L: https://github.com/KGergo88
4445
C: Germany

‎README.html‎

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@
9494
</head>
9595
<body>
9696

97+
<p><a href="https://www.codacy.com/app/holzkohlengrill/Emma?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=bmwcarit/Emma&amp;utm_campaign=Badge_Grade"><img alt="Codacy Badge" src="https://api.codacy.com/project/badge/Grade/8c6208f6f0bf4d429b13e2fa701aa780" /></a> <a href="https://www.codacy.com/app/holzkohlengrill/Emma?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=bmwcarit/Emma&amp;utm_campaign=Badge_Coverage"><img alt="Codacy Badge" src="https://api.codacy.com/project/badge/Coverage/8c6208f6f0bf4d429b13e2fa701aa780" /></a> <a href="https://travis-ci.org/bmwcarit/Emma"><img alt="Build Status" src="https://travis-ci.org/bmwcarit/Emma.svg?branch=master" /></a> <a href="https://www.gnu.org/licenses/gpl-3.0"><img alt="License: GPL v3" src="https://img.shields.io/badge/License-GPLv3-blue.svg" /></a></p>
9798
<h1 id="emma">Emma</h1>
9899
<p><strong>Emma Memory and Mapfile Analyser (Emma)</strong></p>
99100
<blockquote>
@@ -5427,7 +5428,7 @@ <h1 id="contents">Contents</h1>
54275428
<li><a href="#contribute">Contribute</a></li>
54285429
<li><a href="#dependencies--licences">Dependencies &amp; Licences</a></li>
54295430
</ol>
5430-
<p>Install dependencies: <code>pip3 install Pygments Markdown matplotlib pandas pypiscout</code></p>
5431+
<p>Install dependencies: Python 3.6 or higher; <code>pip3 install Pygments Markdown matplotlib pandas pypiscout</code></p>
54315432
<h1 id="general-workflow">General Workflow</h1>
54325433
<p>The following figure shows a possible workflow using Emma:</p>
54335434
<div align="center"> <img src="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABz4AAANNCAYAAADmpNg1AAAABHNCSVQICAgIfAhkiAAAAAlwSFlz
@@ -7659,15 +7660,13 @@ <h2 id="project-files-are-already-present">Project files are already present</h2
76597660
<ol>
76607661
<li>Create intermediate <code>.csv</code> from mapfiles with Emma:</li>
76617662
</ol>
7662-
<div class="codehilite"><pre><span></span>python emma.py -p .<span class="se">\M</span>yProjectFolder --map .<span class="se">\M</span>yProjectFolder<span class="se">\m</span>apfiles --dir .<span class="se">\M</span>yProjectFolder<span class="se">\a</span>nalysis --subdir Analysis_1
7663-
</pre></div>
7663+
<pre class="codehilite"><code class="language-bash">python emma.py -p .\MyProjectFolder --map .\MyProjectFolder\mapfiles --dir .\MyProjectFolder\analysis --subdir Analysis_1</code></pre>
76647664

76657665

76667666
<ol>
76677667
<li>Generate reports and graphs with Emma Visualiser:</li>
76687668
</ol>
7669-
<div class="codehilite"><pre><span></span>python emma_vis.py -p .<span class="se">\M</span>yProjectFolder --dir .<span class="se">\M</span>yProjectFolder<span class="se">\a</span>nalysis --subdir Analysis_1 -q
7670-
</pre></div>
7669+
<pre class="codehilite"><code class="language-bash">python emma_vis.py -p .\MyProjectFolder --dir .\MyProjectFolder\analysis --subdir Analysis_1 -q </code></pre>
76717670

76727671

76737672
<h2 id="project-files-that-have-to-be-created">Project files that have to be created</h2>
@@ -8588,14 +8587,13 @@ <h2 id="project-files-that-have-to-be-created">Project files that have to be cre
85888587
" alt="./doc/images/globalConfigScheme.png" width="60%" /> </div>
85898588

85908589
<p>A <code>globalConfig.json</code> could look like this:</p>
8591-
<div class="codehilite"><pre><span></span><span class="p">{</span>
8592-
<span class="nt">&quot;configID1&quot;</span><span class="p">:</span> <span class="p">{</span>
8593-
<span class="nt">&quot;addressSpacesPath&quot;</span><span class="p">:</span> <span class="s2">&quot;addressSpaces.json&quot;</span><span class="p">,</span>
8594-
<span class="nt">&quot;sectionsPath&quot;</span><span class="p">:</span> <span class="s2">&quot;sections.json&quot;</span><span class="p">,</span>
8595-
<span class="nt">&quot;patternsPath&quot;</span><span class="p">:</span> <span class="s2">&quot;patterns.json&quot;</span>
8596-
<span class="p">}</span>
8597-
<span class="p">}</span>
8598-
</pre></div>
8590+
<pre class="codehilite"><code class="language-json">{
8591+
&quot;configID1&quot;: {
8592+
&quot;addressSpacesPath&quot;: &quot;addressSpaces.json&quot;,
8593+
&quot;sectionsPath&quot;: &quot;sections.json&quot;,
8594+
&quot;patternsPath&quot;: &quot;patterns.json&quot;
8595+
}
8596+
}</code></pre>
85998597

86008598

86018599
<h1 id="full-documentation">Full documentation</h1>

‎README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@ Holding the aforementioned **augmented data** makes it easy to **detect issues i
2323

2424
The Emma visualiser helps you to create nice plots and reports in a `.png` and `.html` and markdown file format.
2525

26-
The whole Emma tool suite contains command line options making it convenient to be **run on a build server** like `-Werror` (treat all warnings as errors) or `--no-prompt` (exit and fail on user prompts; user prompts can happen when ambiguous configurations appear such as multiple matches for one configured map files).
26+
The whole Emma tool suite contains command line options making it convenient to be **run on a build server** like `--Werror` (treat all warnings as errors) or `--no-prompt` (exit and fail on user prompts; user prompts can happen when ambiguous configurations appear such as multiple matches for one configured map files).
2727

2828
------------------------
2929
<br>
3030

31-
<div align="center"> <img src="./doc/images/architecture.png" width="100%" /> </div>
31+
<div align="center"> <img src="./doc/images/architecture.png" width="100%"> </div>
3232

3333
------------------------
3434
# Contents
@@ -46,7 +46,7 @@ Install dependencies: Python 3.6 or higher; `pip3 install Pygments Markdown matp
4646
# General Workflow
4747
The following figure shows a possible workflow using Emma:
4848

49-
<div align="center"> <img src="./doc/images/workflow.png" width="100%" /> </div>
49+
<div align="center"> <img src="./doc/images/workflow.png" width="100%"> </div>
5050

5151
**Emma** - as the core component - produces an intermediate `.csv` file. Inputs are mapfiles and JSON files (for configuration (memory layout, sizes, ...)). From this point you are very flexible to choose your own pipeline. You could
5252

@@ -96,7 +96,7 @@ A basic configuration can be short per file. For complex systems you can choose
9696

9797
One main concept includes the `globalConfig.json`. You can see this as meta-config. Each configuration ID (configID) is a separately conducted analysis. Per configID you state individually the configuration files you want to use for this exact analysis. Herewith you can mix and match any combination of subconfigs you prefer.
9898

99-
<div align="center"> <img src="./doc/images/globalConfigScheme.png" width="60%" /> </div>
99+
<div align="center"> <img src="./doc/images/globalConfigScheme.png" width="60%"> </div>
100100

101101
A `globalConfig.json` could look like this:
102102

0 commit comments

Comments
 (0)