Skip to content

Commit 78b9ba8

Browse files
committed
Update to v0.3.3
1 parent 68112c8 commit 78b9ba8

Some content is hidden

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

45 files changed

+254
-145
lines changed
Loading
Loading
Loading
Loading
Loading
Loading
Loading
Loading

docs/_sources/changelog.rst.txt

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,12 @@
55
matminer Changelog
66
==================
77

8+
**v0.3.3**
9+
10+
* add StackedFeaturizer (L. Ward)
11+
* changes to reference energies in BranchPointEnergy featurizer (A. Faghaninia)
12+
* doc improvements (A. Dunn)
13+
814
**v0.3.2**
915

1016
* Major overhaul / redesign of data retrieval classes for consistency (A. Faghaninia, A. Dunn)

docs/_sources/featurizer_summary.rst.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ Parent classes and meta-featurizers.
3535
Name Description
3636
========================== ================================================================================================================================================================================================================================================================================================================================================================================================================
3737
:code:`MultipleFeaturizer` Class that runs multiple featurizers on the same data `[more] <https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.base.MultipleFeaturizer>`_
38+
:code:`StackedFeaturizer` `[more] <https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.base.StackedFeaturizer>`_
3839
:code:`BaseFeaturizer` Abstract class to calculate features from raw materials input data `[more] <https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.base.BaseFeaturizer>`_
3940
========================== ================================================================================================================================================================================================================================================================================================================================================================================================================
4041

docs/_static/documentation_options.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
var DOCUMENTATION_OPTIONS = {
22
URL_ROOT: '',
3-
VERSION: '0.3.2',
3+
VERSION: '0.3.3',
44
LANGUAGE: 'None',
55
COLLAPSE_INDEX: false,
66
FILE_SUFFIX: '.html',

docs/changelog.html

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
88
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9-
<title>MatMiner Changlog &#8212; matminer 0.3.2 documentation</title>
9+
<title>MatMiner Changlog &#8212; matminer 0.3.3 documentation</title>
1010
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
1111
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1212
<script type="text/javascript" src="_static/documentation_options.js"></script>
@@ -28,7 +28,7 @@ <h3>Navigation</h3>
2828
<li class="right" >
2929
<a href="py-modindex.html" title="Python Module Index"
3030
>modules</a> |</li>
31-
<li class="nav-item nav-item-0"><a href="index.html">matminer 0.3.2 documentation</a> &#187;</li>
31+
<li class="nav-item nav-item-0"><a href="index.html">matminer 0.3.3 documentation</a> &#187;</li>
3232
</ul>
3333
</div>
3434

@@ -39,6 +39,12 @@ <h3>Navigation</h3>
3939

4040
<div class="section" id="matminer-changelog">
4141
<h1>matminer Changelog<a class="headerlink" href="#matminer-changelog" title="Permalink to this headline"></a></h1>
42+
<p><strong>v0.3.3</strong></p>
43+
<ul class="simple">
44+
<li>add StackedFeaturizer (L. Ward)</li>
45+
<li>changes to reference energies in BranchPointEnergy featurizer (A. Faghaninia)</li>
46+
<li>doc improvements (A. Dunn)</li>
47+
</ul>
4248
<p><strong>v0.3.2</strong></p>
4349
<ul class="simple">
4450
<li>Major overhaul / redesign of data retrieval classes for consistency (A. Faghaninia, A. Dunn)</li>
@@ -281,7 +287,7 @@ <h3>Navigation</h3>
281287
<li class="right" >
282288
<a href="py-modindex.html" title="Python Module Index"
283289
>modules</a> |</li>
284-
<li class="nav-item nav-item-0"><a href="index.html">matminer 0.3.2 documentation</a> &#187;</li>
290+
<li class="nav-item nav-item-0"><a href="index.html">matminer 0.3.3 documentation</a> &#187;</li>
285291
</ul>
286292
</div>
287293

docs/contributors.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
88
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9-
<title>MatMiner Contributors &#8212; matminer 0.3.2 documentation</title>
9+
<title>MatMiner Contributors &#8212; matminer 0.3.3 documentation</title>
1010
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
1111
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1212
<script type="text/javascript" src="_static/documentation_options.js"></script>
@@ -28,7 +28,7 @@ <h3>Navigation</h3>
2828
<li class="right" >
2929
<a href="py-modindex.html" title="Python Module Index"
3030
>modules</a> |</li>
31-
<li class="nav-item nav-item-0"><a href="index.html">matminer 0.3.2 documentation</a> &#187;</li>
31+
<li class="nav-item nav-item-0"><a href="index.html">matminer 0.3.3 documentation</a> &#187;</li>
3232
</ul>
3333
</div>
3434

@@ -131,7 +131,7 @@ <h3>Navigation</h3>
131131
<li class="right" >
132132
<a href="py-modindex.html" title="Python Module Index"
133133
>modules</a> |</li>
134-
<li class="nav-item nav-item-0"><a href="index.html">matminer 0.3.2 documentation</a> &#187;</li>
134+
<li class="nav-item nav-item-0"><a href="index.html">matminer 0.3.3 documentation</a> &#187;</li>
135135
</ul>
136136
</div>
137137

docs/example_bulkmod.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
88
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9-
<title>Predicting bulk moduli with matminer &#8212; matminer 0.3.2 documentation</title>
9+
<title>Predicting bulk moduli with matminer &#8212; matminer 0.3.3 documentation</title>
1010
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
1111
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1212
<script type="text/javascript" src="_static/documentation_options.js"></script>
@@ -28,7 +28,7 @@ <h3>Navigation</h3>
2828
<li class="right" >
2929
<a href="py-modindex.html" title="Python Module Index"
3030
>modules</a> |</li>
31-
<li class="nav-item nav-item-0"><a href="index.html">matminer 0.3.2 documentation</a> &#187;</li>
31+
<li class="nav-item nav-item-0"><a href="index.html">matminer 0.3.3 documentation</a> &#187;</li>
3232
</ul>
3333
</div>
3434

@@ -361,7 +361,7 @@ <h3>Navigation</h3>
361361
<li class="right" >
362362
<a href="py-modindex.html" title="Python Module Index"
363363
>modules</a> |</li>
364-
<li class="nav-item nav-item-0"><a href="index.html">matminer 0.3.2 documentation</a> &#187;</li>
364+
<li class="nav-item nav-item-0"><a href="index.html">matminer 0.3.3 documentation</a> &#187;</li>
365365
</ul>
366366
</div>
367367

docs/featurizer_summary.html

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
88
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9-
<title>Table of Featurizers &#8212; matminer 0.3.2 documentation</title>
9+
<title>Table of Featurizers &#8212; matminer 0.3.3 documentation</title>
1010
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
1111
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1212
<script type="text/javascript" src="_static/documentation_options.js"></script>
@@ -28,7 +28,7 @@ <h3>Navigation</h3>
2828
<li class="right" >
2929
<a href="py-modindex.html" title="Python Module Index"
3030
>modules</a> |</li>
31-
<li class="nav-item nav-item-0"><a href="index.html">matminer 0.3.2 documentation</a> &#187;</li>
31+
<li class="nav-item nav-item-0"><a href="index.html">matminer 0.3.3 documentation</a> &#187;</li>
3232
</ul>
3333
</div>
3434

@@ -85,7 +85,10 @@ <h3>Parent classes and meta-featurizers.<a class="headerlink" href="#parent-clas
8585
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">MultipleFeaturizer</span></code></td>
8686
<td>Class that runs multiple featurizers on the same data <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.base.MultipleFeaturizer">[more]</a></td>
8787
</tr>
88-
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">BaseFeaturizer</span></code></td>
88+
<tr class="row-odd"><td><code class="code docutils literal notranslate"><span class="pre">StackedFeaturizer</span></code></td>
89+
<td><a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.base.StackedFeaturizer">[more]</a></td>
90+
</tr>
91+
<tr class="row-even"><td><code class="code docutils literal notranslate"><span class="pre">BaseFeaturizer</span></code></td>
8992
<td>Abstract class to calculate features from raw materials input data <a class="reference external" href="https://hackingmaterials.github.io/matminer/matminer.featurizers.html#matminer.featurizers.base.BaseFeaturizer">[more]</a></td>
9093
</tr>
9194
</tbody>
@@ -417,7 +420,7 @@ <h3>Navigation</h3>
417420
<li class="right" >
418421
<a href="py-modindex.html" title="Python Module Index"
419422
>modules</a> |</li>
420-
<li class="nav-item nav-item-0"><a href="index.html">matminer 0.3.2 documentation</a> &#187;</li>
423+
<li class="nav-item nav-item-0"><a href="index.html">matminer 0.3.3 documentation</a> &#187;</li>
421424
</ul>
422425
</div>
423426

docs/genindex.html

Lines changed: 19 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
<head>
88
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
99
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10-
<title>Index &#8212; matminer 0.3.2 documentation</title>
10+
<title>Index &#8212; matminer 0.3.3 documentation</title>
1111
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
1212
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1313
<script type="text/javascript" src="_static/documentation_options.js"></script>
@@ -29,7 +29,7 @@ <h3>Navigation</h3>
2929
<li class="right" >
3030
<a href="py-modindex.html" title="Python Module Index"
3131
>modules</a> |</li>
32-
<li class="nav-item nav-item-0"><a href="index.html">matminer 0.3.2 documentation</a> &#187;</li>
32+
<li class="nav-item nav-item-0"><a href="index.html">matminer 0.3.3 documentation</a> &#187;</li>
3333
</ul>
3434
</div>
3535

@@ -83,6 +83,8 @@ <h2 id="_">_</h2>
8383
<li><a href="matminer.featurizers.html#matminer.featurizers.bandstructure.BranchPointEnergy.__init__">(matminer.featurizers.bandstructure.BranchPointEnergy method)</a>
8484
</li>
8585
<li><a href="matminer.featurizers.html#matminer.featurizers.base.MultipleFeaturizer.__init__">(matminer.featurizers.base.MultipleFeaturizer method)</a>
86+
</li>
87+
<li><a href="matminer.featurizers.html#matminer.featurizers.base.StackedFeaturizer.__init__">(matminer.featurizers.base.StackedFeaturizer method)</a>
8688
</li>
8789
<li><a href="matminer.featurizers.html#matminer.featurizers.composition.AtomicPackingEfficiency.__init__">(matminer.featurizers.composition.AtomicPackingEfficiency method)</a>
8890
</li>
@@ -273,6 +275,8 @@ <h2 id="C">C</h2>
273275
<li><a href="matminer.featurizers.html#matminer.featurizers.base.BaseFeaturizer.citations">(matminer.featurizers.base.BaseFeaturizer method)</a>
274276
</li>
275277
<li><a href="matminer.featurizers.html#matminer.featurizers.base.MultipleFeaturizer.citations">(matminer.featurizers.base.MultipleFeaturizer method)</a>
278+
</li>
279+
<li><a href="matminer.featurizers.html#matminer.featurizers.base.StackedFeaturizer.citations">(matminer.featurizers.base.StackedFeaturizer method)</a>
276280
</li>
277281
<li><a href="matminer.featurizers.html#matminer.featurizers.composition.AtomicOrbitals.citations">(matminer.featurizers.composition.AtomicOrbitals method)</a>
278282
</li>
@@ -487,6 +491,8 @@ <h2 id="F">F</h2>
487491
<li><a href="matminer.featurizers.html#matminer.featurizers.base.BaseFeaturizer.feature_labels">(matminer.featurizers.base.BaseFeaturizer method)</a>
488492
</li>
489493
<li><a href="matminer.featurizers.html#matminer.featurizers.base.MultipleFeaturizer.feature_labels">(matminer.featurizers.base.MultipleFeaturizer method)</a>
494+
</li>
495+
<li><a href="matminer.featurizers.html#matminer.featurizers.base.StackedFeaturizer.feature_labels">(matminer.featurizers.base.StackedFeaturizer method)</a>
490496
</li>
491497
<li><a href="matminer.featurizers.html#matminer.featurizers.composition.AtomicOrbitals.feature_labels">(matminer.featurizers.composition.AtomicOrbitals method)</a>
492498
</li>
@@ -599,6 +605,8 @@ <h2 id="F">F</h2>
599605
<li><a href="matminer.featurizers.html#matminer.featurizers.base.BaseFeaturizer.featurize">(matminer.featurizers.base.BaseFeaturizer method)</a>
600606
</li>
601607
<li><a href="matminer.featurizers.html#matminer.featurizers.base.MultipleFeaturizer.featurize">(matminer.featurizers.base.MultipleFeaturizer method)</a>
608+
</li>
609+
<li><a href="matminer.featurizers.html#matminer.featurizers.base.StackedFeaturizer.featurize">(matminer.featurizers.base.StackedFeaturizer method)</a>
602610
</li>
603611
<li><a href="matminer.featurizers.html#matminer.featurizers.composition.AtomicOrbitals.featurize">(matminer.featurizers.composition.AtomicOrbitals method)</a>
604612
</li>
@@ -917,6 +925,8 @@ <h2 id="I">I</h2>
917925
<li><a href="matminer.featurizers.html#matminer.featurizers.base.BaseFeaturizer.implementors">(matminer.featurizers.base.BaseFeaturizer method)</a>
918926
</li>
919927
<li><a href="matminer.featurizers.html#matminer.featurizers.base.MultipleFeaturizer.implementors">(matminer.featurizers.base.MultipleFeaturizer method)</a>
928+
</li>
929+
<li><a href="matminer.featurizers.html#matminer.featurizers.base.StackedFeaturizer.implementors">(matminer.featurizers.base.StackedFeaturizer method)</a>
920930
</li>
921931
<li><a href="matminer.featurizers.html#matminer.featurizers.composition.AtomicOrbitals.implementors">(matminer.featurizers.composition.AtomicOrbitals method)</a>
922932
</li>
@@ -1100,8 +1110,6 @@ <h2 id="M">M</h2>
11001110
<li><a href="matminer.featurizers.html#module-matminer.featurizers.base">matminer.featurizers.base (module)</a>
11011111
</li>
11021112
<li><a href="matminer.featurizers.html#module-matminer.featurizers.composition">matminer.featurizers.composition (module)</a>
1103-
</li>
1104-
<li><a href="matminer.featurizers.data_files.html#module-matminer.featurizers.data_files">matminer.featurizers.data_files (module)</a>
11051113
</li>
11061114
<li><a href="matminer.featurizers.html#module-matminer.featurizers.dos">matminer.featurizers.dos (module)</a>
11071115
</li>
@@ -1113,10 +1121,10 @@ <h2 id="M">M</h2>
11131121
</li>
11141122
<li><a href="matminer.featurizers.html#module-matminer.featurizers.structure">matminer.featurizers.structure (module)</a>
11151123
</li>
1116-
</ul></td>
1117-
<td style="width: 33%; vertical-align: top;"><ul>
11181124
<li><a href="matminer.figrecipes.html#module-matminer.figrecipes">matminer.figrecipes (module)</a>
11191125
</li>
1126+
</ul></td>
1127+
<td style="width: 33%; vertical-align: top;"><ul>
11201128
<li><a href="matminer.figrecipes.html#module-matminer.figrecipes.plot">matminer.figrecipes.plot (module)</a>
11211129
</li>
11221130
<li><a href="matminer.utils.html#module-matminer.utils">matminer.utils (module)</a>
@@ -1263,11 +1271,13 @@ <h2 id="S">S</h2>
12631271
</ul></li>
12641272
<li><a href="matminer.featurizers.html#matminer.featurizers.structure.SineCoulombMatrix">SineCoulombMatrix (class in matminer.featurizers.structure)</a>
12651273
</li>
1266-
</ul></td>
1267-
<td style="width: 33%; vertical-align: top;"><ul>
12681274
<li><a href="matminer.featurizers.html#matminer.featurizers.structure.SiteStatsFingerprint">SiteStatsFingerprint (class in matminer.featurizers.structure)</a>
12691275
</li>
1276+
</ul></td>
1277+
<td style="width: 33%; vertical-align: top;"><ul>
12701278
<li><a href="matminer.featurizers.html#matminer.featurizers.stats.PropertyStats.sorted">sorted() (matminer.featurizers.stats.PropertyStats static method)</a>
1279+
</li>
1280+
<li><a href="matminer.featurizers.html#matminer.featurizers.base.StackedFeaturizer">StackedFeaturizer (class in matminer.featurizers.base)</a>
12711281
</li>
12721282
<li><a href="matminer.featurizers.html#matminer.featurizers.stats.PropertyStats.std_dev">std_dev() (matminer.featurizers.stats.PropertyStats static method)</a>
12731283
</li>
@@ -1420,7 +1430,7 @@ <h3>Navigation</h3>
14201430
<li class="right" >
14211431
<a href="py-modindex.html" title="Python Module Index"
14221432
>modules</a> |</li>
1423-
<li class="nav-item nav-item-0"><a href="index.html">matminer 0.3.2 documentation</a> &#187;</li>
1433+
<li class="nav-item nav-item-0"><a href="index.html">matminer 0.3.3 documentation</a> &#187;</li>
14241434
</ul>
14251435
</div>
14261436

docs/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
88
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9-
<title>matminer (Materials Data Mining) &#8212; matminer 0.3.2 documentation</title>
9+
<title>matminer (Materials Data Mining) &#8212; matminer 0.3.3 documentation</title>
1010
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
1111
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1212
<script type="text/javascript" src="_static/documentation_options.js"></script>
@@ -28,7 +28,7 @@ <h3>Navigation</h3>
2828
<li class="right" >
2929
<a href="py-modindex.html" title="Python Module Index"
3030
>modules</a> |</li>
31-
<li class="nav-item nav-item-0"><a href="#">matminer 0.3.2 documentation</a> &#187;</li>
31+
<li class="nav-item nav-item-0"><a href="#">matminer 0.3.3 documentation</a> &#187;</li>
3232
</ul>
3333
</div>
3434

@@ -229,7 +229,7 @@ <h3>Navigation</h3>
229229
<li class="right" >
230230
<a href="py-modindex.html" title="Python Module Index"
231231
>modules</a> |</li>
232-
<li class="nav-item nav-item-0"><a href="#">matminer 0.3.2 documentation</a> &#187;</li>
232+
<li class="nav-item nav-item-0"><a href="#">matminer 0.3.3 documentation</a> &#187;</li>
233233
</ul>
234234
</div>
235235

docs/installation.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<head>
77
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
88
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9-
<title>Installing matminer &#8212; matminer 0.3.2 documentation</title>
9+
<title>Installing matminer &#8212; matminer 0.3.3 documentation</title>
1010
<link rel="stylesheet" href="_static/nature.css" type="text/css" />
1111
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
1212
<script type="text/javascript" src="_static/documentation_options.js"></script>
@@ -28,7 +28,7 @@ <h3>Navigation</h3>
2828
<li class="right" >
2929
<a href="py-modindex.html" title="Python Module Index"
3030
>modules</a> |</li>
31-
<li class="nav-item nav-item-0"><a href="index.html">matminer 0.3.2 documentation</a> &#187;</li>
31+
<li class="nav-item nav-item-0"><a href="index.html">matminer 0.3.3 documentation</a> &#187;</li>
3232
</ul>
3333
</div>
3434

@@ -120,7 +120,7 @@ <h3>Navigation</h3>
120120
<li class="right" >
121121
<a href="py-modindex.html" title="Python Module Index"
122122
>modules</a> |</li>
123-
<li class="nav-item nav-item-0"><a href="index.html">matminer 0.3.2 documentation</a> &#187;</li>
123+
<li class="nav-item nav-item-0"><a href="index.html">matminer 0.3.3 documentation</a> &#187;</li>
124124
</ul>
125125
</div>
126126

0 commit comments

Comments
 (0)