Skip to content

Commit 82511ae

Browse files
authored
Merge pull request #7 from MikeHeiber/development
Everything look good!
2 parents ea0be1c + c2dcd6a commit 82511ae

File tree

77 files changed

+1604
-330
lines changed

Some content is hidden

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

77 files changed

+1604
-330
lines changed

.travis.yml

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ compiler:
1414

1515
env:
1616
- OPTIONS="GCC_VERSION=4.7 && MPI=openmpi && TARGET=test_coverage"
17+
- OPTIONS="GCC_VERSION=4.7 && MPI=openmpi && TARGET=test_default"
18+
- OPTIONS="GCC_VERSION=4.7 && MPI=openmpi && TARGET=test_example1"
1719
- OPTIONS="GCC_VERSION=4.7 && MPI=mpich2 && TARGET=test"
1820
- OPTIONS="GCC_VERSION=4.7 && MPI=openmpi && TARGET=test"
1921
- OPTIONS="GCC_VERSION=4.8 && MPI=mpich2 && TARGET=test"
@@ -41,7 +43,10 @@ before_install:
4143
- if [[ "$MPI" = openmpi ]]; then sudo apt-get -y install -qq openmpi-bin libopenmpi-dev; fi
4244
- if [[ "$TARGET" = test_coverage ]]; then pip install --user cpp-coveralls; fi
4345

44-
script:
45-
- make -j10 $TARGET && travis_wait ./test/Ising_OPV_tests.exe && travis_wait mpiexec -n 4 ./test/Ising_OPV_MPI_tests.exe
46+
script:
47+
- if [[ "$TARGET" = test ]]; then make -j10 test && travis_wait ./test/Ising_OPV_tests.exe && travis_wait mpiexec -n 4 ./test/Ising_OPV_MPI_tests.exe; fi
48+
- if [[ "$TARGET" = test_default ]]; then make -j10 && travis_wait mpiexec -n 4 ./Ising_OPV.exe parameters_default.txt; fi
49+
- if [[ "$TARGET" = test_example1 ]]; then make -j10 && travis_wait mpiexec -n 4 ./Ising_OPV.exe ./examples/example1/parameters_ex1.txt; fi
50+
- if [[ "$TARGET" = test_coverage ]]; then make -j10 test_coverage && travis_wait ./test/Ising_OPV_tests.exe && travis_wait mpiexec -n 4 ./test/Ising_OPV_MPI_tests.exe; fi
4651
- if [[ "$TARGET" = test_coverage ]]; then coveralls --include src --exclude "googletest/*" --gcov-options '\-lp'; fi
47-
- if [[ "$TARGET" = test ]]; then make -j10 && mpiexec -n 4 ./Ising_OPV.exe parameters_default.txt; fi
52+

Doxyfile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ PROJECT_NAME = Ising_OPV
3838
# could be handy for archiving the generated documentation or if some version
3939
# control system is used.
4040

41-
PROJECT_NUMBER = v4.0-beta.1
41+
PROJECT_NUMBER = v4.0.0-rc.2
4242

4343
# Using the PROJECT_BRIEF tag one can provide an optional one line description
4444
# for a project that appears at the top of each page and should give viewer a
@@ -2203,7 +2203,7 @@ PERL_PATH = /usr/bin/perl
22032203
# powerful graphs.
22042204
# The default value is: YES.
22052205

2206-
CLASS_DIAGRAMS = YES
2206+
CLASS_DIAGRAMS = NO
22072207

22082208
# You can define message sequence charts within doxygen comments using the \msc
22092209
# command. Doxygen will then run the mscgen tool (see:
@@ -2412,7 +2412,7 @@ INTERACTIVE_SVG = NO
24122412
# found. If left blank, it is assumed the dot tool can be found in the path.
24132413
# This tag requires that the tag HAVE_DOT is set to YES.
24142414

2415-
DOT_PATH =
2415+
DOT_PATH = "C:/Program Files (x86)/Graphviz2.38/bin"
24162416

24172417
# The DOTFILE_DIRS tag can be used to specify one or more directories that
24182418
# contain dot files that are included in the documentation (see the \dotfile

README.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,8 @@ Generated or imported morphologies are then rigorously analyzed to determine imp
1414
- Create morphology sets from imported experimental three-dimensional tomograms
1515
- Calculate detailed structural analysis of the morphology set
1616

17+
<img src="./papers/v4_paper/tomogram_analysis.png" alt="Tomography data import and analysis workflow" width="650">
18+
1719
## Current Status
1820

1921
Latest release: [![GitHub (pre-)release](https://img.shields.io/github/release/MikeHeiber/Ising_OPV/all.svg?style=flat-square)](https://github.com/MikeHeiber/Ising_OPV/releases)
@@ -35,8 +37,8 @@ Code is being tested using [googletest](https://github.com/google/googletest) wi
3537

3638
| Branch | Status |
3739
| :------: | ------ |
38-
| Master | [![Coveralls github branch](https://img.shields.io/coveralls/github/MikeHeiber/Ising_OPV/master.svg?style=for-the-badge)](https://coveralls.io/github/MikeHeiber/Ising_OPV?branch=master) |
39-
| Development | [![Coveralls github branch](https://img.shields.io/coveralls/github/MikeHeiber/Ising_OPV/development.svg?style=for-the-badge)](https://coveralls.io/github/MikeHeiber/Ising_OPV?branch=development) |
40+
| Master | [![Coveralls Github branch](https://img.shields.io/coveralls/github/MikeHeiber/Ising_OPV/master.svg?style=for-the-badge)](https://coveralls.io/github/MikeHeiber/Ising_OPV?branch=master) |
41+
| Development | [![Coveralls Github branch](https://img.shields.io/coveralls/github/MikeHeiber/Ising_OPV/development.svg?style=for-the-badge)](https://coveralls.io/github/MikeHeiber/Ising_OPV?branch=development) |
4042

4143
## Contact
4244

@@ -81,7 +83,7 @@ Similar batch scripts can also be written for TORQUE or other job schedulers.
8183

8284
Regardless of the job scheduler, the program execution command is essentially the same.
8385
Ising_OPV.exe takes one required input argument, which is the filename of the input parameter file.
84-
An annotated example parameter file is provided with this package (parameters_default.txt).
86+
An annotated default parameter file is provided with this package (parameters_default.txt).
8587

8688
For example, to create 10 morphologies using 10 processors with the default parameters, the command is:
8789

@@ -91,11 +93,13 @@ Users can also import morphology sets previously generated by the Ising_OPV tool
9193
This will import the morphologies (morphology_0.txt, morphology_1.txt, etc) and assign one to each processor.
9294
The morphology files must be located in the working directory to be found and imported.
9395

94-
Finally, users can also import experimental tomogram image data, generate a morphology set from the data, and then perform further operations by enabling tomogram import in the parameter file and specifying the name of tomogram dataset.
96+
Finally, users can also import experimental 3D tomography image data, generate a morphology set from the data, and then perform further operations by enabling tomogram import in the parameter file and specifying the name of tomogram dataset.
9597
The tomogram metadata is imported from an XML metadata file and then that is used for interpreting a RAW binary data file that contains the image data.
98+
The metadata format required by Ising_OPV is defined in XML schema definition file, tomogram_metadata.xsd.
9699
Once the tomogram data is loaded, the morphology can be segmented into a number of equally size sub-volumes to form a new morphology set, and then the rest of the analysis is performed.
97100
Again, the tomogram dataset files must be located in the working directory to be found and imported.
98-
Also, the metadata format required by Ising_OPV is defined in XML schema definition file, tomogram_metadata.xsd.
101+
102+
For more detailed examples, please see the [Examples](./examples/examples.md) file.
99103

100104
#### Simulation Output
101105

@@ -124,11 +128,15 @@ While this tool is designed to be primarily controlled through the parameter fil
124128
## Citing this Work
125129

126130
If you find Ising_OPV to be helpful for your research, please cite the original study:
131+
127132
[M. C. Heiber and A. Dhinojwala, Phys. Rev. Appl. **2**, 014008 (2014).](http://journals.aps.org/prapplied/abstract/10.1103/PhysRevApplied.2.014008) [[ResearchGate]](https://www.researchgate.net/publication/264419218_Efficient_Generation_of_Model_Bulk_Heterojunction_Morphologies_for_Organic_Photovoltaic_Device_Modeling)
128133

129134
If your work involves investigating the effects of morphological tortuosity, please also cite the study that introduced the tortuosity features:
135+
130136
[M.C. Heiber, K. Kister, A. Baumann, V. Dyakonov, C. Deibel, and T.-Q. Nguyen, Phys. Rev. Appl. **8**, 054043 (2017).](https://journals.aps.org/prapplied/abstract/10.1103/PhysRevApplied.8.054043) [[ResearchGate]](https://www.researchgate.net/publication/321226076_Impact_of_Tortuosity_on_Charge-Carrier_Transport_in_Organic_Bulk_Heterojunction_Blends)
131137

138+
In addition, please also cite the DOI for the specific version that you used from [Zenodo.org](https://zenodo.org/search?page=1&size=20&q=conceptrecid:%22592959%22&sort=-version&all_versions=True).
139+
132140
## Additional Reference List
133141
Several peer-reviewed publications discuss the development and application of this software tool:
134142

@@ -140,7 +148,7 @@ Several peer-reviewed publications discuss the development and application of th
140148
- [M.C. Heiber, K. Kister, A. Baumann, V. Dyakonov, C. Deibel, and T.-Q. Nguyen, Phys. Rev. Appl. **8**, 054043 (2017).](https://journals.aps.org/prapplied/abstract/10.1103/PhysRevApplied.8.054043) [[ResearchGate]](https://www.researchgate.net/publication/321226076_Impact_of_Tortuosity_on_Charge-Carrier_Transport_in_Organic_Bulk_Heterojunction_Blends)
141149

142150
## Acknowledgments
143-
Thank you to Dr. Dean DeLongchamp at NIST for providing access to computing resources that support the ongoing development of v4.0.
151+
Thank you to Dr. Dean M. DeLongchamp at NIST for providing access to computing resources that support the ongoing development of v4.0.
144152
Development of v4.0 is supported by financial assistance award 70NANB14H012 from U.S. Department of Commerce, National Institute of Standards and Technology as part of the Center for Hierarchical Materials Design (CHiMaD).
145153

146154
Thank you to Klaus Kister for contributing to the development of the updated domain smoothing algorithm and the simplified morphology import procedure in v2.0 and help with testing for v3.0.
Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2+
<html xmlns="http://www.w3.org/1999/xhtml">
3+
<head>
4+
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6+
<meta name="generator" content="Doxygen 1.8.14"/>
7+
<meta name="viewport" content="width=device-width, initial-scale=1"/>
8+
<title>Ising_OPV: CODE_OF_CONDUCT.md File Reference</title>
9+
<link href="tabs.css" rel="stylesheet" type="text/css"/>
10+
<script type="text/javascript" src="jquery.js"></script>
11+
<script type="text/javascript" src="dynsections.js"></script>
12+
<link href="navtree.css" rel="stylesheet" type="text/css"/>
13+
<script type="text/javascript" src="resize.js"></script>
14+
<script type="text/javascript" src="navtreedata.js"></script>
15+
<script type="text/javascript" src="navtree.js"></script>
16+
<script type="text/javascript">
17+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
18+
$(document).ready(initResizable);
19+
/* @license-end */</script>
20+
<link href="search/search.css" rel="stylesheet" type="text/css"/>
21+
<script type="text/javascript" src="search/searchdata.js"></script>
22+
<script type="text/javascript" src="search/search.js"></script>
23+
<link href="doxygen.css" rel="stylesheet" type="text/css" />
24+
</head>
25+
<body>
26+
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
27+
<div id="titlearea">
28+
<table cellspacing="0" cellpadding="0">
29+
<tbody>
30+
<tr style="height: 56px;">
31+
<td id="projectalign" style="padding-left: 0.5em;">
32+
<div id="projectname">Ising_OPV
33+
&#160;<span id="projectnumber">v4.0.0-rc.2</span>
34+
</div>
35+
<div id="projectbrief">Generates and analyzes model bulk heterojunction morphologies in a parallel computing environment</div>
36+
</td>
37+
</tr>
38+
</tbody>
39+
</table>
40+
</div>
41+
<!-- end header part -->
42+
<!-- Generated by Doxygen 1.8.14 -->
43+
<script type="text/javascript">
44+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
45+
var searchBox = new SearchBox("searchBox", "search",false,'Search');
46+
/* @license-end */
47+
</script>
48+
<script type="text/javascript" src="menudata.js"></script>
49+
<script type="text/javascript" src="menu.js"></script>
50+
<script type="text/javascript">
51+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
52+
$(function() {
53+
initMenu('',true,false,'search.php','Search');
54+
$(document).ready(function() { init_search(); });
55+
});
56+
/* @license-end */</script>
57+
<div id="main-nav"></div>
58+
</div><!-- top -->
59+
<div id="side-nav" class="ui-resizable side-nav-resizable">
60+
<div id="nav-tree">
61+
<div id="nav-tree-contents">
62+
<div id="nav-sync" class="sync"></div>
63+
</div>
64+
</div>
65+
<div id="splitbar" style="-moz-user-select:none;"
66+
class="ui-resizable-handle">
67+
</div>
68+
</div>
69+
<script type="text/javascript">
70+
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
71+
$(document).ready(function(){initNavTree('_c_o_d_e___o_f___c_o_n_d_u_c_t_8md.html','');});
72+
/* @license-end */
73+
</script>
74+
<div id="doc-content">
75+
<!-- window showing the filter options -->
76+
<div id="MSearchSelectWindow"
77+
onmouseover="return searchBox.OnSearchSelectShow()"
78+
onmouseout="return searchBox.OnSearchSelectHide()"
79+
onkeydown="return searchBox.OnSearchSelectKey(event)">
80+
</div>
81+
82+
<!-- iframe showing the search results (closed by default) -->
83+
<div id="MSearchResultsWindow">
84+
<iframe src="javascript:void(0)" frameborder="0"
85+
name="MSearchResults" id="MSearchResults">
86+
</iframe>
87+
</div>
88+
89+
<div class="header">
90+
<div class="headertitle">
91+
<div class="title">CODE_OF_CONDUCT.md File Reference</div> </div>
92+
</div><!--header-->
93+
<div class="contents">
94+
</div><!-- contents -->
95+
</div><!-- doc-content -->
96+
<!-- start footer part -->
97+
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
98+
<ul>
99+
<li class="navelem"><a class="el" href="_c_o_d_e___o_f___c_o_n_d_u_c_t_8md.html">CODE_OF_CONDUCT.md</a></li>
100+
<li class="footer">Generated by
101+
<a href="http://www.doxygen.org/index.html">
102+
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.14 </li>
103+
</ul>
104+
</div>
105+
</body>
106+
</html>

docs/_lattice_8cpp.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
<tr style="height: 56px;">
3131
<td id="projectalign" style="padding-left: 0.5em;">
3232
<div id="projectname">Ising_OPV
33-
&#160;<span id="projectnumber">v4.0-beta.2</span>
33+
&#160;<span id="projectnumber">v4.0.0-rc.2</span>
3434
</div>
3535
<div id="projectbrief">Generates and analyzes model bulk heterojunction morphologies in a parallel computing environment</div>
3636
</td>

docs/_lattice_8h.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
<tr style="height: 56px;">
3131
<td id="projectalign" style="padding-left: 0.5em;">
3232
<div id="projectname">Ising_OPV
33-
&#160;<span id="projectnumber">v4.0-beta.2</span>
33+
&#160;<span id="projectnumber">v4.0.0-rc.2</span>
3434
</div>
3535
<div id="projectbrief">Generates and analyzes model bulk heterojunction morphologies in a parallel computing environment</div>
3636
</td>

docs/_lattice_8h_source.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
<tr style="height: 56px;">
3131
<td id="projectalign" style="padding-left: 0.5em;">
3232
<div id="projectname">Ising_OPV
33-
&#160;<span id="projectnumber">v4.0-beta.2</span>
33+
&#160;<span id="projectnumber">v4.0.0-rc.2</span>
3434
</div>
3535
<div id="projectbrief">Generates and analyzes model bulk heterojunction morphologies in a parallel computing environment</div>
3636
</td>

docs/_morphology_8cpp.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
<tr style="height: 56px;">
3131
<td id="projectalign" style="padding-left: 0.5em;">
3232
<div id="projectname">Ising_OPV
33-
&#160;<span id="projectnumber">v4.0-beta.2</span>
33+
&#160;<span id="projectnumber">v4.0.0-rc.2</span>
3434
</div>
3535
<div id="projectbrief">Generates and analyzes model bulk heterojunction morphologies in a parallel computing environment</div>
3636
</td>

docs/_morphology_8h.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
<tr style="height: 56px;">
3131
<td id="projectalign" style="padding-left: 0.5em;">
3232
<div id="projectname">Ising_OPV
33-
&#160;<span id="projectnumber">v4.0-beta.2</span>
33+
&#160;<span id="projectnumber">v4.0.0-rc.2</span>
3434
</div>
3535
<div id="projectbrief">Generates and analyzes model bulk heterojunction morphologies in a parallel computing environment</div>
3636
</td>

docs/_morphology_8h_source.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@
3030
<tr style="height: 56px;">
3131
<td id="projectalign" style="padding-left: 0.5em;">
3232
<div id="projectname">Ising_OPV
33-
&#160;<span id="projectnumber">v4.0-beta.2</span>
33+
&#160;<span id="projectnumber">v4.0.0-rc.2</span>
3434
</div>
3535
<div id="projectbrief">Generates and analyzes model bulk heterojunction morphologies in a parallel computing environment</div>
3636
</td>

0 commit comments

Comments
 (0)